Skip to content

Commit

Permalink
fill in readme/license/contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmonkey4eva committed Jun 4, 2023
1 parent 1c6e3a6 commit bc2b807
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,4 @@
Contribution to Denizen
-----------------------

Refer to the Denizen contribution guide: https://github.com/DenizenScript/Denizen/blob/dev/CONTRIBUTING.md
4 changes: 2 additions & 2 deletions LICENSE.txt
@@ -1,6 +1,6 @@
MIT License
The MIT License (MIT)

Copyright (c) 2022-2023 The DenizenScript Team
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
Expand Down
51 changes: 49 additions & 2 deletions README.md
@@ -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.

0 comments on commit bc2b807

Please sign in to comment.