generated from Zelaux/ZelauxMindustryModTemplate
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
69 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,79 @@ | ||
#  | ||
|
||
[](https://discord.gg/bNMT82Hswb) | ||
[](https://discord.gg/bNMT82Hswb) | ||
[](https://www.youtube.com/@omaloon) | ||
|
||
[](https://github.com/xStaBUx/Omaloon-mod-public) | ||
[](https://github.com/xStaBUx/Omaloon-mod-public/releases)[](https://github.com/xStaBUx/Omaloon-mod-public/releases) | ||
[](https://github.com/xStaBUx/Omaloon-mod-public) | ||
[](https://github.com/xStaBUx/Omaloon-mod-public/releases) | ||
[](https://github.com/xStaBUx/Omaloon-mod-public/releases) | ||
|
||
>An ambitious [Mindustry](https://github.com/Anuken/Mindustry) modification developed by xstabux, uujuju/Aurora and randomguy. Mod aimed at expanding the game's standard campaign by adding a new star system. | ||
An ambitious [Mindustry](https://github.com/Anuken/Mindustry) modification developed by stabu and uujuju. This mod aims to expand the game's standard campaign by adding a new star system. | ||
|
||
## Contributing | ||
|
||
You can contribute on development by: | ||
## Building from Source | ||
|
||
* Submitting bug reports in [Issues](https://github.com/xStaBUx/Omaloon-mod-public/issues) category. | ||
* Suggesting new content (The Issues category is **not** for suggestions, better visit the Omaloon's [discord server](https://discord.gg/bNMT82Hswb)) | ||
* Providing input regarding content balancing | ||
### Prerequisites | ||
|
||
## Compiling | ||
- JDK 17 or higher | ||
- Android SDK (for Android builds) | ||
- Git | ||
|
||
1. Clone repository. | ||
### Setup | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone -b master --single-branch https://github.com/xstabux/Omaloon | ||
``` | ||
//TODO | ||
|
||
2. Set up environment variables: | ||
- Set `ANDROID_SDK_ROOT` or `ANDROID_HOME` to your Android SDK installation path (required for Android builds) | ||
|
||
### Building | ||
|
||
For Desktop: | ||
```bash | ||
gradlew jar | ||
``` | ||
|
||
For Android: | ||
```bash | ||
gradlew dex | ||
``` | ||
|
||
The built mod will be in the `build/libs` directory. | ||
|
||
### Running | ||
|
||
To test the mod directly: | ||
```bash | ||
gradlew run | ||
``` | ||
|
||
To install the mod to your Mindustry mods folder: | ||
```bash | ||
gradlew installJar | ||
``` | ||
|
||
## Contributing | ||
|
||
### Bug Reports | ||
- Submit bug reports in the [Issues](https://github.com/xStaBUx/Omaloon-mod-public/issues) section | ||
- Include detailed steps to reproduce the issue | ||
- Mention your game version and mod version | ||
|
||
### Feature Suggestions | ||
- Join our [Discord server](https://discord.gg/bNMT82Hswb) to suggest new content | ||
- The Issues section is reserved for bug reports only | ||
|
||
### Balance Feedback | ||
- Share your thoughts on content balancing in our Discord | ||
- Provide specific examples and reasoning for balance changes | ||
|
||
## Credits | ||
|
||
### Developers | ||
- stabu - Lead Dev | ||
- uujuju - Dev | ||
### Contributors | ||
- randomguy - Weathers code | ||
- zelaux - Arc library, some code | ||
- saigononozomi - Music |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters