Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.98 KB

README.md

File metadata and controls

52 lines (39 loc) · 2.98 KB
Raw


About Wynntils

Wynntils is a Wynncraft mod that seeks to enhance the user's gameplay with a variety of customizable options and additions. If you find any bug or have crashed because of the mod, please report it at our official Discord server!

Setup the Workspace

To set up the workspace, just import the project as a gradle project into your IDE
To build the mod just call the buildDependents and the artifact should be generated in build/libs.

You can also setup a test environment. Run the task for generating run configurations for your IDE

  • Eclipse - genEclipseRuns
  • Intellij - genIntellijRuns
  • VSCode - genVSCodeRuns

When launching a run configuration use the generated run configuration

  • All IDEs - runClient

Authenticating

To authenticate in the development environment, you should use DevAuth. Download and place the forge-legacy.jar from their releases in run/mods. When you first launch the game with the generated runClient task, there will be a prompt in the console with a link to authenticate. No other configuration is required.

Alternative Accounts

This repository is pre-configured with one main and one alternative account. To use the alternative account, you should duplicate, then edit the generated runClient configuration. In the JVM arguments for your duplicated configuration, add -Ddevauth.account=alt. You will be prompted to authenticate with the new account when you run the new instance.

To add more alternative accounts, you should edit .devauth/config.toml in your local copy of this repository and follow the existing entries as examples. You may also refer to the DevAuth repository for more information.

Pull Request

All pull requests are welcome. We'll analyse it and if we determine it should a part of the mod, we'll implement it.

We welcome all forms of assistance. =)

If you would like to make a pull request, please compare and merge it with Wynntils:development rather than Wynntils:production.
Additionally, please name your pull request according to the Conventional Commits specification.

License

Wynntils is licensed over the license GNU Affero General Public License v3.0
All the assets are over Wynntils domain © Wynntils.