Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fill in readme/license/contributing file
- Loading branch information
1 parent
1c6e3a6
commit bc2b807
Showing
3 changed files
with
55 additions
and
4 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Contribution to Denizen | ||
----------------------- | ||
|
||
Refer to the Denizen contribution guide: https://github.com/DenizenScript/Denizen/blob/dev/CONTRIBUTING.md |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,50 @@ | ||
# Clientizen | ||
Clientizen | ||
---------- | ||
|
||
WIP | ||
Denizen, on your Minecraft client! Operates as a Fabric mod, and integrates with Denizen on the server directly. | ||
|
||
Currently targeting Minecraft 1.19.4. | ||
|
||
### Status | ||
|
||
DEV ONLY. Not quite ready for real use. Contributors welcome! (Chat with us on [Discord](https://discord.gg/Q6pZGSR)) | ||
|
||
### Building | ||
|
||
Built against JDK 17 using gradle and [Fabric-Loom](https://github.com/FabricMC/fabric-loom). | ||
|
||
Run `./gradlew clean build` (for Windows it's `.\gradlew.bat`) to build the project. The built jar will be in `build/libs`. | ||
|
||
### Licensing pre-note: | ||
|
||
This is an open source project, provided entirely freely, for everyone to use and contribute to. | ||
|
||
If you make any changes that could benefit the community as a whole, please contribute upstream. | ||
|
||
### The short of the license is: | ||
|
||
You can do basically whatever you want, except you may not hold any developer liable for what you do with the software. | ||
|
||
### The long version of the license follows: | ||
|
||
The MIT License (MIT) | ||
|
||
Copyright (c) 2022-2023 The Denizen Script Team | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |