Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ducdat0507 committed Dec 15, 2023
1 parent 2743eec commit f7db401
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions readme.md
Expand Up @@ -7,9 +7,16 @@

![Looks, name, and chart not final](Previews/preview.gif)

## How to Contribute Code / Make Charts
## How to Make Charts
* Download the Standalone Chartmaker [(in releases)](https://github.com/ducdat0507/JANOARG/releases)
* Unpack .zip and run Chartmaker.exe
* Have fun!

### You'll need the following:
Note: The Standalone Chartmaker has less features than the Unity Editor-based Chartmaker and is in the pre-release stage, however the standalone version does not require Unity Editor to run. If you can run Unity and open this project I recommend using the Unity Editor version for the time being.

## How to Contribute Code

### You'll nreleaseseed the following:
* A personal computer (Windows/Mac/Linux, the editor isn't available on mobile, sorry)
* A copy of Unity Editor (preferably version 2022.2.2)
* A code editor (any text editor should work)
Expand All @@ -18,15 +25,8 @@
### Instructions
* Clone the project (by downloading it to your computer or by running the following command in the cmd/terminal: `git clone https://github.com/ducdat0507/JANOARG.git`).
* Open the root folder using the Unity Editor.
* If you want to make charts:
* Put your music into the project. It is recommended to organize your charts by putting songs into separate folders inside `Assets/Resources/Songs` so the songs don't get included in commits (we currently do not accept song submissions through git).
* Open the chartmaker: On the menu bar, click JANOARG > Chartmaker
* Enter your song's information in the fields below the "or create a new one" label.
* Click the "Create New Chart" button. A file will be created inside the folder that the song is currently in.
* Click the song name in the top left corner and press the "Create New Chart" button to make a new chart. You can create as many charts as you'd like.
* If you want to contribute code:
* Make edits to the code (of course)
* Send the project (by making a pull request)
* Make edits to the code (of course)
* Send the project (by making a pull request)

## Contact
We have a [Discord server](https://discord.gg/vXJTPFQBHm) for discussions/official songlist submission
Expand Down

0 comments on commit f7db401

Please sign in to comment.