Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Commit

Permalink
Update to 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
megamaz committed Jan 30, 2021
1 parent 22fdf0e commit 7a155e6
Show file tree
Hide file tree
Showing 21 changed files with 808 additions and 968 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ test_pytest.py
venv
NoodleExtensions.egg-info
dist
Releases
Releases
.vscode
*.bat
62 changes: 29 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Python Noodle Extensions Editor (PNEE)
*pronounced /nē/ (Ni)*
Current Version: 2.0.0\
Check your installed version by doing `pip show NoodleExtensions`. If you are not on 2.0.0, do `pip install --ugprade NoodleExtensions`.
```
PPPPPPPPPPPPPPPPP NNNNNNNN NNNNNNNNEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE
P::::::::::::::::P N:::::::N N::::::NE::::::::::::::::::::EE::::::::::::::::::::E
Expand All @@ -21,29 +22,27 @@ PPPPPPPPPP NNNNNNNN NNNNNNNEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE
## my to-do list
If you want to know what's currently on my to-do list, you can go [here](https://trello.com/b/yA5qQTs7)! Pull requests, feedback, issues, and more are appreciated. If you'd like to contact me, you can do so on discord at `megamaz#1020`
## What is it?
This is a Python Noodle Extensions Editor for Beat Saber levels. Manually editing a JSON file over a long period of time can get really annoying, so this should speed up the process!
This is a Python Noodle Extensions Editor for Beat Saber levels. Manually editing a JSON file over a long period of time can get really annoying, so this should speed up the process!\
### The docs are still a work in progress. If you have any questions on how to use the script or need help, you can contact me on discord at `megamaz#1020`

## How do I use it?
The docs can be found [Here!](https://github.com/megamaz/NoodleExtensions-python/blob/master/docs/documentation.md)\
As of installation, you can simply `pip install NoodleExtensions` and you'll be ready to `import noodle_extensions` inside your project.\
No credits are required! Suprisingly a few people have asked me about that. this is just meant to be helpful and if you'd like to give credit that's fine.
## Sample
```py
import noodleExtensions as NE

## Extra notes:
- Made entirely in python
- Pull requests are appreciated, but follow the [pull requests](#pull-request) steps
# Samples
editor = NE.NoodleExtensions(r"level.datpath")

## Simple (blank) animation
```py
from noodle_extensions import Editor, Animator
from noodle_extensions.constants import EventType, Animations
# assign to a new track
dropNote = NE.Note(5, 1, 0, 0, 8, _track="FallDownTrack")
editor.createNote(dropNote)

editor = Editor("YourLevel.datPath")
animator = Animator(editor)
FallDownTrack = NE.AnimateTrack(2, "FallDownTrack", 2, _position=[
[0, 100, 0, 0], # be in the sky before it appears
[0, 0, 0, 0.75, "easeOutBounce"], # fall down in front of player and finish animation just in time for the player to hit it
])
editor.animateTrack(FallDownTrack)

# Animations can go here.
# Basic position animation (that does nothing)
animator.animate(EventType().AnimateTrack, Animations().position, [[0, 0]], "DummyTrack", 0, 3)
# push events to the level.dat so it can be ready to play
editor.pushChanges()
```
# Pull Request
To make a pull request, please test your code either using [pytest](https://docs.pytest.org/en/stable/) or your python testing env. of your choice.\
Expand All @@ -52,20 +51,17 @@ I will not be accepting any form of pull request if the test files have not been
2. Edit code
3. *Test* your code
4. If check 3 is done, move on to step 5
5. Make the pull request\
a. Give it a meaningful title. \
b. Give it a meaningful description.\
c. I'll review it when I have time. I'm a busy man\
5. Make the pull request
## Current Issues:
None (Contact me at `megamaz#1020` if you run into any issues)
#### Currently testing features (checked features have been tested and are working)
* [ ] Editor.updateDependencies
* [X] Editor.editBlock
* [X] Editor.editWall
* [X] Editor.getBlock
* [X] Editor.getWall
* [X] Editor.removeEvent
* [X] Animator.animate
* [X] Animator.animateBlock
* [X] Animator.animateWall
* [X] Animator.editTrack
* [X] updateDependencies
* [X] pushChanges
* [X] getNote
* [X] getWall
* [X] editNote
* [X] editWall
* [X] animateTrack
* [X] assignPathAnimation
* [X] assignTrackParent
* [X] assignPlayerToTrack
2 changes: 2 additions & 0 deletions dev_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-e .
pytest
289 changes: 0 additions & 289 deletions docs/documentation.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/images/.txt

This file was deleted.

Binary file removed docs/images/bounce.gif
Binary file not shown.
Binary file removed docs/images/rotate.gif
Binary file not shown.
Loading

0 comments on commit 7a155e6

Please sign in to comment.