Files
ESE/README.md
Yonokid 217e6b28d5 fix links
not using a fork for this because this is important and a very small fix
2022-11-01 02:46:49 +01:00

26 lines
2.2 KiB
Markdown

# Every Song Ever
TJADB presents the ESE (Every Song Ever) project
ESE covers all the official Taiko no Tatsujin (太鼓の達人) songs
## How to get the songs
We recommend to use git to "clone" the songs. As you can see, the project is very large, and gets updated on a regular basis. Using git, you can avoid having to manually update the songs on your system by copying and overwriting local files. A simple `git pull` will make sure you have the latest version of all the .tja's.
If you don't want to use git, you can just download the project as a zip folder. We recommend against this, but it is an option.
### What is git?
Git is a "version control" software that allows people to work together on a same project, without running into the risk of messing up each others work when editing the same file. This allows our **ESE maintainers** to add and fix songs in an easy way. In the unlikely event they mess up, they can use git to go back to a previous version. This gives them full freedom to try things out without the fear of losing their progress.
The benefits of git for the **TJADB community** is that you can keep your official repository up to date.
- Was the sync of a song off? If the ESE crew fixes that, you can update your song list, and get these updates.
- New songs were published? One command will make sure you can get these
- Not sure if you have old versions of the songs? Git will fix this for you.
### How do I use git?
Git, in essence, is a command-line tool. However, there are graphical tools available that use git.
If you want to use the command-line, you can use the following steps:
1. Open a CMD or Powershell command prompt
2. Navigate to your game directory. You can do this by typing `cd <path to your game folder>`
3. If you already have a `songs` folder, rename it for now. This way you have a copy, just in case
4. Type `git clone --depth 1 -b master https://ese.tjadataba.se/ESE/ESE.git Songs`
This will download the songs from the ese.tjadataba.se website. This will take a while
**NOTE:** If you want to work on ESE, you do not want to make a "shallow clone", like the one above. Instead, type `git clone https://ese.tjadataba.se/ESE/ESE.git Songs`