70 lines
3.1 KiB
Markdown
70 lines
3.1 KiB
Markdown
# Downloading ESE via. Git
|
|
|
|
Below is a simple guide to downloading & updating ESE.
|
|
|
|
This setup is optimized for only downloading ESE, and is not optimized for creating & sending changes to the ESE repository. To discuss/contribute changes to ESE, post in the #ese channel on Discord. Contributors with access to TJADB's Gitea should not be following this guide.
|
|
|
|
It is recommended that you do not modify anything inside of your ESE folder yourself, otherwise you may run into merge conflicts in future updates.
|
|
|
|
## 1. Download Git
|
|
|
|
[Download and install Git here](https://git-scm.com/download).
|
|
|
|
## 2. Locate your Songs folder
|
|
|
|
### Windows
|
|
|
|
In File Explorer, locate your folder containing your TJA program (TJAPlayer3, TNDE, OpenTaiko, etc.) and open your Songs folder.
|
|
Inside your Songs folder, right-click on the directory near the top of the window & select "Copy address as text".
|
|
|
|
In Command Prompt, run `cd C:/Your/Path/Name` to go to your Songs folder. (Replace `C:/Your/Path/Name/` with the pathname you just copied from File Explorer)
|
|
|
|
### Mac
|
|
|
|
In Finder, locate your folder containing your TJA program (TJAPlayer3, TNDE, OpenTaiko, etc.).
|
|
If your Path Bar is not visible, go to View -> Show Path Bar to make it visible.
|
|
Ctrl-click on your Songs folder, hold the Option key, and select "Copy "Songs" as Pathname".
|
|
|
|
In Terminal, run `cd ~/Your/Path/Name` to go to your Songs folder. (Replace `~/Your/Path/Name` with the pathname you just copied from Finder)
|
|
|
|
### Linux
|
|
|
|
If you're running Linux, you probably already know how to get your path name and change directories.
|
|
Navigate to your Songs folder via. terminal.
|
|
|
|
## 3. Downloading ESE
|
|
|
|
In your Songs folder, run the following command to clone ESE :
|
|
|
|
```
|
|
git clone https://ese.tjadataba.se/ESE/ESE.git ESE
|
|
```
|
|
|
|
This will create a sub-folder titled "ESE" and put all ESE songs in that folder. You can rename "ESE" to something else if you prefer a different folder name.
|
|
Please note that ESE is huge, and will take a while to download. This process may be even slower if multiple people are downloading at once.
|
|
|
|
Once everything is downloaded, it'll take much less time to download any future updates.
|
|
*Do not delete the .git folder or README.md after downloading! You will need them if you want to update your folder.*
|
|
|
|
# Updating ESE
|
|
|
|
Change your directory so that you're in your ESE folder rather than your Songs folder.
|
|
In your ESE songs folder, run the following command to update your ESE folder :
|
|
|
|
```
|
|
git pull
|
|
```
|
|
|
|
## Dealing with Merge Conflicts
|
|
|
|
If you've modified any of your ESE files, you will eventually run into a merge conflict, which means that changes to a file are present on both the repository & your local folder. You'll likely run into this when you're updating/fixing a TJA & sending it in to be uploaded to the repository.
|
|
|
|
The easiest way to resolve merge conflicts is by restoring your ESE folder.
|
|
In your terminal, locate your ESE folder & run the following command :
|
|
|
|
```
|
|
git restore .
|
|
```
|
|
|
|
This will discard any personal changes you've made to any file within the ESE folder.
|
|
**Your scores & OPTK replays are safe and will not be wiped.** |