bonkmaykr/firestar
bonkmaykr/firestar
2
1
Fork 0
Code Issues 3 Pull Requests Packages Releases 6 Wiki Activity

add build directions to readme

Browse Source
This commit is contained in:
Downforce Agent 2024-07-25 23:16:53 -05:00
parent a57e5695a5
commit 4aa017f7ac
1 changed files with 50 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,6 +1,6 @@
![](https://files.worlio.com/users/bonkmaykr/http/git/embed/firestar.png)
**Firestar is a cross-platform Java-based mod manager for WipEout 2048**, which runs on a desktop/laptop computer and aims to allow easy installation of mods for users with very little hassle. It is compatible with both real PSVita hardware, as well as emulators.
**Firestar is a cross-platform Java-based mod manager for WipEout 2048**, which runs on a desktop/laptop computer and aims to allow easy installation of mods with very little hassle. It is compatible with both real PSVita hardware, as well as with emulators.
## Get Started: [>> CLICK HERE <<](https://git.worlio.com/bonkmaykr/firestar/wiki)
@ -24,6 +24,35 @@ If you aren't sure which file to get:
- **Version 1.3 and above only:** [Visual C++ 2012 libraries](http://www.microsoft.com/en-au/download/confirmation.aspx?id=30679)
- Do NOT install Firestar directly to your PSVita's storage. Some of it's file operations do not play nice with FAT filesystems.
# Building
You are always free to copy the Firestar source code and compile the latest work-in-progress version for yourself.
Firestar uses the Gradle build system. We write our code and perform all our tests on Linux, but these same steps should apply to all major operating systems.
## With Intellij IDEA
1. Create a new project cloned from this Git repo
2. Open the run configurations editor by clicking "Default" in the top right corner and selecting "Edit Configurations".
3. Set the JDK to Java 17, the module to firestar.firestar.main and the main class to Firestar's Main class.
4. Go to Modify Options > Add before launch task, then add a Gradle "clean" task
5. Go there again and add a Gradle "build" task
6. Delete the default build task that has now appeared as step 1.
7. Save your options and click the Play button to compile and test.
## From the command line
1. Ensure you have both Git and Gradle installed on your system.
- Windows: Visit [git-scm.com](https://git-scm.com/downloads) and the [Gradle Installation Guide](https://gradle.org/install/).
- Linux/BSD: Install the `git` and `gradle` packages from your package manager. For example:
- Arch-based: `sudo pacman -Sy git gradle` (if this breaks your computer then run -Syu to rectify it)
- Debian-based: `sudo apt install git gradle`
- Mac: Figure it out! None of us on the dev team use Macs and we can't be assed to.
2. Open the terminal and clone the git repo. This will download the Firestar source code to a `firestar/` folder in your current working directory.
```
git clone https://git.worlio.com/bonkmaykr/firestar.git
```
3. `cd` to `firestar/` and run `./gradlew build` to make a JAR or `./gradlew run` to test your code immediately.
- On Windows systems make sure you're running `gradlew.bat` and not the Bash script instead.
# FAQ
## Can I use this on a Vita without enso/HEN?
No. You need a modded Vita in order to use this. Hacking a Vita is super easy these days, but if you don't want to, you can always use Vita3K instead.