seppuku/readme.md

# ![Seppuku](res/seppuku_full.png)

![Website](https://img.shields.io/website?down_color=lightgrey&down_message=offline&up_color=darkgreen&up_message=online&url=https%3A%2F%2Fseppuku.pw%2F)
![Discord](https://img.shields.io/discord/579516739092480000?color=lightblue)
![License](https://img.shields.io/github/license/seppukudevelopment/seppuku)
![GitHub Version](https://img.shields.io/github/v/release/seppukudevelopment/seppuku)
![GitHub Lines](https://img.shields.io/tokei/lines/github/seppukudevelopment/seppuku)
![GitHub Contributors](https://img.shields.io/github/contributors/seppukudevelopment/seppuku?color=lightgrey)
![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...

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).

Check the [guide](https://seppuku.pw/guide.html) for help.

# Requirements
- **JDK 8** (https://adoptopenjdk.net/, https://aws.amazon.com/corretto/)
- __(optional)__ **Git**

# Building

### Linux / Mac
1. Clone the repository: `git clone git@github.com:seppukudevelopment/seppuku.git`
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`.

Your .jar file is 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/`.

# 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.
Add logo to readme 2019-10-27 23:32:26 +00:00			`# ![Seppuku](res/seppuku_full.png)`
Add readme pasted from website 2019-10-27 23:30:38 +00:00
Update readme.md 2020-12-28 21:26:42 +00:00			`![Website](https://img.shields.io/website?down_color=lightgrey&down_message=offline&up_color=darkgreen&up_message=online&url=https%3A%2F%2Fseppuku.pw%2F)`
			`![Discord](https://img.shields.io/discord/579516739092480000?color=lightblue)`
			`![License](https://img.shields.io/github/license/seppukudevelopment/seppuku)`
			`![GitHub Version](https://img.shields.io/github/v/release/seppukudevelopment/seppuku)`
			`![GitHub Lines](https://img.shields.io/tokei/lines/github/seppukudevelopment/seppuku)`
			`![GitHub Contributors](https://img.shields.io/github/contributors/seppukudevelopment/seppuku?color=lightgrey)`
			`![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)`

Update readme.md 2020-12-25 23:36:43 +00:00			`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...`

			`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).`
Update readme.md 2019-11-03 18:12:06 +00:00
Update readme.md 2020-12-28 23:14:21 +00:00			`Check the [guide](https://seppuku.pw/guide.html) for help.`

Update readme.md 2019-11-03 18:12:06 +00:00			`# Requirements`
Fix corretto href linking to Italian website 2019-11-03 18:40:23 +00:00			`- JDK 8 (https://adoptopenjdk.net/, https://aws.amazon.com/corretto/)`
Update readme.md 2019-11-03 18:12:06 +00:00			`- __(optional)__ Git`

			`# Building`

			`### Linux / Mac`
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00			1. Clone the repository: `git clone git@github.com:seppukudevelopment/seppuku.git`
Update readme 2020-12-29 21:42:20 +00:00			2. Run `./gradlew clean`
			3. Run `./gradlew setupDecompWorkspace`
			4. Edit `build.gradle` and change field `buildmode` to `RELEASE`. (e.g. `def
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00			buildmode = "RELEASE"`)
Update readme 2020-12-29 21:42:20 +00:00			5. Run `./gradlew build`.
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00
			Your .jar file is in `build/libs/`.
Update readme.md 2019-11-03 18:12:06 +00:00
Update readme.md 2019-11-25 02:20:41 +00:00			`#### Windows`
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00			`> Using a git shell for Windows and using the linux guide above is highly recommended. (https://git-scm.com/downloads)`
Update readme 2020-12-29 21:42:20 +00:00			`1. Clone the repository.`
			2. Import the project through Gradle via `build.gradle`. *(simple tutorials online for
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00			`[intellij](https://stackoverflow.com/questions/31256356/how-to-import-gradle-projects-in-intellij),`
Update readme 2020-12-29 21:42:20 +00:00			`[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
Update readme.md 2019-12-18 20:46:39 +00:00			buildmode = "RELEASE"`
Update readme 2020-12-29 21:42:20 +00:00			7. Run the gradle command `build` via the IDE or gradlew.bat file. *(via
			command prompt: `gradlew.bat build`)*
readme.md formatting, fix VelocityModule and optimize, fix TotemNotifierModule null check 2020-07-09 22:53:05 +00:00
			Your .jar file is in `build/libs/`.
Update readme.md 2019-11-03 18:27:59 +00:00
			`# Debugging`
			- Use VM arg `-Dfml.coreMods.load=me.rigamortis.seppuku.impl.fml.core.SeppukuLoadingPlugin`
Update readme.md 2019-11-21 03:32:43 +00:00			- Ensure field `buildmode` in build.gradle is set to `IDE` ex: `def buildmode = "IDE"`
Update readme 2020-12-29 21:42:20 +00:00			- Repeat the steps from `step #2` in the Building guide written above to fix errors.