RepoMirrors/seppuku
1
0
Fork 1
mirror of https://github.com/seppukudevelopment/seppuku synced 2025-03-08 13:47:31 +00:00
Code Issues Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Ossian Winter 2021-01-22 15:45:39 +01:00
parent 0e29f97299
commit 2785677ce5
No known key found for this signature in database
GPG Key ID: 1017BE95C68A39F9
1 changed files with 33 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
readme.md
View File

@ -9,45 +9,49 @@
![GitHub Language](https://img.shields.io/github/languages/top/seppukudevelopment/seppuku?color=9900ee)
![Downloads](https://img.shields.io/github/downloads/seppukudevelopment/seppuku/total?color=9900ee)
Seppuku is a free, lightweight, open-source [_Minecraft Forge_](https://files.minecraftforge.net/) mod for Minecraft 1.12.2, and soon to be for recent versions...
Seppuku is a free, open-source and lightweight Minecraft 1.12.2 [_Forge_](https://files.minecraftforge.net/) mod, and soon to be for more recent versions.
Originally oriented towards the 9B9T and 2B2T anarchy servers; it is a fully featured client-side mod with an external plugin API, unique exploits, and a [solid Discord community](https://discord.gg/UzWBZPe).
Originally oriented towards the 9B9T and 2B2T anarchy servers; it is a fully featured client-side mod with an external plugin system, unique exploits, and a [solid Discord community](https://discord.gg/UzWBZPe).
Check the [guide](https://seppuku.pw/guide.html) for help.
Checkout the [guide](https://seppuku.pw/guide.html) for help.
# Requirements
- **JDK 8** (https://adoptopenjdk.net/, https://aws.amazon.com/corretto/)
- __(optional)__ **Git**
- **JDK 8** ([AdoptOpenJDK](https://adoptopenjdk.net/) or [Corretto](https://aws.amazon.com/corretto/) is recommended)
- __(optional)__ **[Git](https://git-scm.com)**
# Building
### Linux / Mac
1. Clone the repository: `git clone git@github.com:seppukudevelopment/seppuku.git`
### IntelliJ and Eclipse
**Using an IDE like IntelliJ or Eclipse is strongly recommended**
1. Download either [IntelliJ](https://www.jetbrains.com/idea/) or [Eclipse](https://www.eclipse.org/)
2. Clone (or download) the repository: `git clone https://github.com/seppukudevelopment/seppuku`
3. Import the project (steps for [IntelliJ](https://www.jetbrains.com/help/idea/gradle.html#gradle_import_project_start) and [Eclipse](https://stackoverflow.com/questions/10722773/import-existing-gradle-git-project-into-eclipse))
4. Run the Gradle task `clean` via your IDE
5. Run the Gradle task `setupDecompWorkspace` via your IDE
6. Edit `build.gradle` and change the field `buildmode` to `RELEASE` (e.g. `def buildmode = "RELEASE"`)
7. Run the Gradle task `build` via your IDE
The newly built jar file can be found in `build/libs/`.
### Linux, Unix and Mac
1. Clone (or download) the repository: `git clone https://github.com/seppukudevelopment/seppuku`
2. Run `./gradlew clean`
3. Run `./gradlew setupDecompWorkspace`
4. Edit `build.gradle` and change field `buildmode` to `RELEASE`. (e.g. `def
buildmode = "RELEASE"`)
5. Run `./gradlew build`.
4. Edit `build.gradle` and change the field `buildmode` to `RELEASE` (e.g. `def buildmode = "RELEASE"`)
5. Run `./gradlew build`
Your .jar file is in `build/libs/`.
The newly built jar file can be found in `build/libs/`.
#### Windows
> Using a git shell for Windows and using the linux guide above is highly recommended. (https://git-scm.com/downloads)
1. **Clone** the repository.
2. **Import** the project through Gradle via `build.gradle`. *(simple tutorials online for
[intellij](https://stackoverflow.com/questions/31256356/how-to-import-gradle-projects-in-intellij),
[eclipse](https://stackoverflow.com/questions/10722773/import-existing-gradle-git-project-into-eclipse), etc...)*
3. Run the Gradle command `clean` via the IDE or the gradlew.bat file. *(via command prompt: `./gradlew.bat clean`)*
4. Run the Gradle command `setupDecompWorkspace` via the IDE or gradlew.bat file. *(via command prompt: `./gradlew.bat setupDecompWorkspace`)*
5. *(for IDE building only <IntelliJ / Eclipse / etc...> )*: **Refresh the project** *(reload ide or refresh gradle workspace)*
6. **Edit** `build.gradle` and change field `buildmode` to `RELEASE` ex: `def
buildmode = "RELEASE"`
7. **Run** the gradle command `build` via the IDE or gradlew.bat file. *(via
command prompt: `gradlew.bat build`)*
Your .jar file is in `build/libs/`.
### Windows
1. Clone (or download) the repository: `git clone https://github.com/seppukudevelopment/seppuku`
2. Run `./gradlew.bat clean`
3. Run `./gradlew.bat setupDecompWorkspace`
4. Edit `build.gradle` and change the field `buildmode` to `RELEASE` (e.g. `def buildmode = "RELEASE"`)
5. Run `./gradlew.bat build`
The newly built jar file can be found in `build/libs/`.
# Debugging
- Use VM arg `-Dfml.coreMods.load=me.rigamortis.seppuku.impl.fml.core.SeppukuLoadingPlugin`
- Ensure field `buildmode` in **build.gradle** is set to `IDE` ex: `def buildmode = "IDE"`
- Repeat the steps from `step #2` in the **Building** guide written above to fix errors.
- Use the JVM argument `-Dfml.coreMods.load=me.rigamortis.seppuku.impl.fml.core.SeppukuLoadingPlugin`
- Ensure the field `buildmode` in `build.gradle` is set to `IDE` (e.g `def buildmode = "IDE"`)
- If any error occurs try running the Gradle task `clean` (see steps under aformentioned building section), if the error persists feel free to ask for help in the [Discord support channel](https://discord.gg/tTu72JEQUm)