Skip to content

Commit

Permalink
Improve & document testing changes (#22)
Browse files Browse the repository at this point in the history
* Add instructions to test changes

* Simplify setup using `DevAuth` system properties

* Minor wording fix

* Use the `Minecraft Client` run configuration

* Better formatting, link Fabric docs

* Can also use `ideaSyncTask`

* Don't remove trailing spaces from markdown files
  • Loading branch information
tal5 committed Jun 6, 2023
1 parent c413f88 commit e71b19e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Expand Up @@ -32,3 +32,6 @@ indent_size = 2
[.editorconfig]
indent_style = space
indent_size = 4

[*.md]
trim_trailing_whitespace=false
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -2,3 +2,13 @@ Contribution to Denizen
-----------------------

Refer to the Denizen contribution guide: https://github.com/DenizenScript/Denizen/blob/dev/CONTRIBUTING.md

## Testing changes

The instructions below are targeted at the `Intellij IDEA` IDE, although the process should be similar for most IDEs.
You will be using the `Minecraft Client` run configuration to run a Minecraft client with Clientizen from within your IDE; as the client that runs does not include authentication by default, Clientizen makes use of the `DevAuth` mod to enable that.
Go into your IDE, select the `Minecraft Client` run configuration from the run menu at the top bar (if it's missing, restart your IDE or run the `ideaSyncTask` Gradle task), and press run.
Note the run terminal opening below, where `DevAuth` will output a link for you to authenticate your Microsoft account.
You should only need to do that once (and after the token expires, which seems to be about 90 days according to the `DevAuth` developer), after that you will be able to simply run the `Minecraft Client` run configuration to start a Minecraft client with Clientizen.

For more information regarding setup in specific IDEs, preferred settings, and generating & reading Minecraft sources, see [Fabric's docs](https://fabricmc.net/wiki/tutorial:setup#intellij_idea).
9 changes: 9 additions & 0 deletions build.gradle
Expand Up @@ -43,6 +43,15 @@ dependencies {
modRuntimeOnly("me.djtheredstoner:DevAuth-fabric:${project.devauth_version}")
}

loom {
runs {
client {
property("devauth.enabled", "true")
property("devauth.account", "alt") // DevAuth's name for the Microsoft account in the default config
}
}
}


processResources {
inputs.property "version", version
Expand Down

0 comments on commit e71b19e

Please sign in to comment.