CR_OmniPower_Mod/readme.md
pietru 39089ed81d
All checks were successful
/ Auto-Build-App (push) Successful in 1m11s
add icon
2024-07-29 17:21:03 +02:00

35 lines
No EOL
1.3 KiB
Markdown

# OmniPower Mod
Mod for game Cosmic Reach.\
Based on the example mod for the [Cosmic Quilt](https://codeberg.org/CRModders/cosmic-quilt) Loader
## Mod requires
- Cosmic Reach (0.1.24+)
- Cosmic Quilt (2.0.2+)
- Flux API (0.5.9+)
<br>
<br>
Mod Licensed under licensed under MIT like license. <br>
Check <code>license.txt</code> for details.
<br>
<br>
I call OmniPower license MIT Like cause I belive you can do what you want with it as long as you are not selling it.
<br>
By selling I don't mean selling other mod that might use OmniPower Power Action.
So as long as you are using OmniPower for API feel free to treat license like MIT.
## How to test/build
For testing in the dev env, you can use the `gradle run` task
For building, the usual `gradle build` task can ba used\
the output will be in the `build/libs/` folder
## Wiki
For a wiki on how to use Cosmic Quilt & Quilt, please look at the [Cosmic Quilt wiki](https://codeberg.org/CRModders/cosmic-quilt/wiki)
## Notes
- Most project properties can be changed in the `gradle.properties`
- To change author, description and stuff that isnt there, edit `src/main/resources/quilt.mod.json`
- The project name is defined in `settings.gradle`
- To add Quilt mods in the build, make sure to use `quiltMod` rather than `implementation`