https://github.com/cyclopsmc/generator-cyclops
A simple Cyclops mod template generator
https://github.com/cyclopsmc/generator-cyclops
forge java minecraft
Last synced: 3 months ago
JSON representation
A simple Cyclops mod template generator
- Host: GitHub
- URL: https://github.com/cyclopsmc/generator-cyclops
- Owner: CyclopsMC
- License: mit
- Created: 2015-11-05T20:51:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T20:31:13.000Z (about 3 years ago)
- Last Synced: 2025-01-11T10:18:03.551Z (over 1 year ago)
- Topics: forge, java, minecraft
- Language: Java
- Size: 315 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## generator-cyclops
This is a simple Cyclops mod template generator.
### Requirements
* [Node](https://nodejs.org/en/)
* [Yo](https://www.npmjs.com/package/yo)
### Usage
Run `npm link` in this directory for installing this generator.
Running `yo cyclops:mod` will create a new mod directory based on the answers you provide to the questions.
You will need to fill in the following things when using this template:
* Update secret keys and repo locations in `.travis.yml`
* Encrypt keystore file in `.travis.yml`
If using travis, you will need to enter the following secrets in your build settings:
* `CURSEFORGE_KEY_SECRET`: Your curseforge key for automatic release publishing when a new tag is pushed
* `MAVEN_URL`: (Optional), for automatic dev build publishing
* `MAVEN_USERNAME`: (Optional), maven username for the dev build publishing
* `MAVEN_KEY`: (Optional), maven password for the dev build publishing
* `SIGN_KEYSTORE`: Keystore file
* `SIGN_ALIAS`: Keystore alias
* `SIGN_STOREPASS`: Keystore pass
* `SIGN_KEYPASS`: Key pass
### Branching Strategy
For every major Minecraft version, two branches exist:
* `master-{mc_version}`: Latest (potentially unstable) development.
* `release-{mc_version}`: Latest stable release for that Minecraft version. This is also tagged with all mod releases.
### License
All code and images are licenced under the [MIT License](https://github.com/CyclopsMC/generator-cyclops/blob/master-1.8/LICENSE.txt)