- Added INSTALL.md file with build instructions

- Added placeholder CHANGELOG.md file, to track releases
- Added CONTRIBUTING.md with instructions on how to contribute
- Updated "Creature Chat" name to "CreatureChat"
- Updated README.md (new resource links, removed upgrade notes, simplified some sections

CHANGELOG.md

+# Changelog
+
+All notable changes to **CreatureChat** are documented in this file. The format is based on 
+[Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to 
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Placeholder
+
+## [1.0.0] - 2024-05-01
+
+### Added
+- Launch initial version of the mod.
+- Placeholder

CONTRIBUTING.md

+# Contributing to CreatureChat
+
+First off, thank you for considering contributing to CreatureChat! It's people like you that 
+make the Minecraft modding community such a great place to be a part of. Here are a few 
+guidelines that we ask contributors to follow to make the process easy and effective for 
+everyone involved.
+
+## Getting Started
+
+Before you begin:
+
+- Ensure you have a [GitLab account](https://gitlab.openshot.org/) linked to your email.
+- Familiarize yourself with the [GitLab Flow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) to understand our branch management and release structure.
+- Make sure you have a basic understanding of the [Fabric modding platform](https://fabricmc.net/).
+
+## Making Changes
+
+1. **Fork the Repository**
+    - Fork the project repository: http://gitlab.openshot.org/minecraft/creature-chat
+    - Clone your fork to your local machine and set up the development environment as described in [INSTALL.md](INSTALL.md).
+
+2. **Create a Branch**
+    - Create a new branch from where you want to base your work.
+    - Use a clear branch name that describes the intent of your changes.
+
+3. **Make Your Changes**
+    - Make the changes in your fork following the coding conventions and guidelines.
+    - Commit your changes. Keep your commits as small as possible but include complete and informative commit messages.
+
+4. **Test Your Changes**
+    - Ensure your changes do not break any existing functionality.
+    - Test your changes thoroughly, making sure they provide the functionality described in your branch name.
+
+5. **Push Changes**
+    - Push your changes to your fork on GitLab.
+
+## Submitting a Merge Request
+
+1. **Merge Request**
+    - Make sure your branch is up to date with the main project branch you are targeting.
+    - Submit a merge request to the main repository in the appropriate branch.
+    - Include a descriptive title and a detailed first comment describing what your changes do.
+
+2. **Review Process**
+    - Other contributors and maintainers will review your merge request. Be open to discussing potential improvements.
+    - Make any requested changes to your merge request. This might require more commits.
+
+3. **Final Review and Merge**
+    - Once your merge request is approved, a project maintainer will merge it.
+
+## Reporting Bugs
+
+- Bugs are tracked as GitLab issues. Create an issue on our repository and clearly describe the bug with as much detail as possible, steps to reproduce, expected outcome, and actual outcome.
+
+## Community
+
+- Join our [Discord](https://discord.gg/m9dvPFmN3e) to chat with other contributors and get help with your development questions.
+
+Thank you for your contributions to the CreatureChat mod!

INSTALL.md

+# Building CreatureChat
+
+This **guide** will walk you through the steps required to clone and build the CreatureChat 
+**Fabric Mod** from our **Git** repository. _NOTE: Please ensure you have Git installed on your 
+computer before you begin. You will also need Java and an appropriate Gradle setup to 
+build the mod._
+
+## Prerequisites
+- **Git**: If you don't have Git installed, download and install it from [git-scm.com](https://git-scm.com/).
+- **Java JDK**: Fabric requires Java Development Kit (JDK) to compile and run. Download 
+  and install it from [AdoptOpenJDK](https://adoptopenjdk.net/) or your preferred JDK provider. JDK version 8 or 11 
+  is recommended.
+- **IDE**: Any IDE that supports Java and Gradle, such as **IntelliJ IDEA**, **Eclipse**, or **VS Code**.
+
+## Clone the Repository
+Open a terminal or command prompt and run the following command to clone the repository:
+```
+git clone http://gitlab.openshot.org/minecraft/creature-chat.git
+```
+
+Navigate into the cloned directory:
+```
+cd creature-chat
+```
+
+## Build the Mod
+Use the Gradle wrapper included in the repository to build the project. Run the 
+following command in the terminal within the project directory:
+
+```
+./gradlew build
+```
+
+For **Windows** users, use:
+
+```
+gradlew.bat build
+```
+
+This command compiles the project and outputs the build artifacts, including the 
+mod `.jar` file, into the `build/libs` directory.
+
+## Testing the Mod
+To test the mod, you can run it in a development environment provided by Fabric:
+
+```
+./gradlew runClient
+```
+
+For **Windows** users, use:
+
+```
+gradlew.bat runClient
+```
+
+This command launches a Minecraft client with the mod loaded, allowing you to 
+test the mod's functionality directly.
+
+## Updating Dependencies
+
+When Fabric or Minecraft is updated, the build dependencies also need to
+be updated. Below are the general steps for this upgrade process.
+
+1. Visit https://fabricmc.net/develop for updated version #s
+1. Copy/paste the recommended versions into `gradle.properties`
+1. **Optional:** Update the Loom version in `build.gradle`
+1. Re-build: `./gradlew build` and watch for any errors
+1. Re-run: `./gradlew runClient`
+1. **Optional:** Re-start **IDE** to clear cached gradle

README.md

@@ -20,7 +20,7 @@ Ready to deepen your Minecraft journey with meaningful conversations and endurin
 
 ## Installation
 1. **Install Fabric Loader**: Follow the instructions [here](https://fabricmc.net/use/).
-1. **Install CreatureChat Mod**: Place `creaturechat-*.jar` and `fabric-api-*.jar` into your `.minecraft/mods`
+1. **Install CreatureChat Mod**: Download and move `creaturechat-*.jar` and `fabric-api-*.jar` into your `.minecraft/mods`
    folder.
 1. **Create an OpenAI API key**: Visit https://platform.openai.com/api-keys, and use the `+ Create new secret key` button.
    Copy/Paste your key into the `/creaturechat key set <your-secret-key-here>` command. 
@@ -54,35 +54,17 @@ The CreatureChat mod allows users to configure settings via in-game commands. He
 ![Enderman Following the Player](src/main/resources/assets/creaturechat/screenshots/enderman-follow.png)
 ![Chat UI](src/main/resources/assets/creaturechat/screenshots/chat-ui.png)
 
-## Upgrade Dependencies
-
-When Fabric or Minecraft is updated, the build dependencies need to also
-be updated. Below are the general steps for this upgrade process.
-
-1. Visit https://fabricmc.net/develop for updated version #s
-1. Copy/paste the recommended versions into `gradle.properties`
-1. **Optional:** Update the Loom version in `build.gradle` 
-1. Re-build: `./gradlew build` and watch for any errors
-1. Re-run: `./gradlew runClient`
-1. **Optional:** Re-start **IntelliJ IDEA** to clear cached gradle
-
-## Costs Associated with Third-Party LLM APIs
-Using third-party Large Language Model (LLM) APIs, such as OpenAI, will incur usage-based fees. 
+## Costs & Security
+Using third-party Large Language Model (LLM) APIs, such as OpenAI, will incur usage-based **fees**. 
 These fees are typically based on the amount of data processed or the number of requests made 
 to the service. Before integrating or using these APIs, please review the pricing details 
-provided by the API provider. Be aware of the potential costs and plan your usage accordingly 
+provided by the API provider. Be aware of the **potential costs** and plan your usage accordingly 
 to avoid unexpected charges.
 
 By using this software and integrating third-party APIs, you acknowledge and agree to take 
-full responsibility for securing your API keys and managing API usage within the terms and 
+full responsibility for **securing** your API keys and managing API usage within the terms and 
 cost structures outlined by the providers.
 
-## API Key Confidentiality
-Always keep your API keys confidential to prevent unauthorized access and potential misuse.
-Exposing your API key publicly can lead to security risks, unauthorized usage, and potential
-service abuse. Treat your API keys as sensitive information and only share them with trusted
-parties within secure environments.
-
 ## Authors
 
 - Jonathan Thomas <jonathan@openshot.org>
@@ -90,8 +72,12 @@ parties within secure environments.
 
 ## Contact & Resources
 
-- [Source Code](http://gitlab.openshot.org/minecraft/creature-chat)
 - [Join us on Discord](https://discord.gg/m9dvPFmN3e)
+- [Build Instructions](INSTALL.md) ([Source Code](http://gitlab.openshot.org/minecraft/creature-chat))
+- Download from [Modrinth](https://modrinth.com/project/creaturechat) or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/creaturechat)
+- Follow Us: [YouTube](https://www.youtube.com/@CreatureChat/featured) | 
+[Twitter](https://twitter.com/TheCreatureChat) |
+[TikTok](https://www.tiktok.com/@creaturechat)
 
 ## License
 

src/main/resources/fabric.mod.json

@@ -2,8 +2,8 @@
 	"schemaVersion": 1,
 	"id": "creaturechat",
 	"version": "${version}",
-	"name": "Creature Chat",
-	"description": "Elevate your Minecraft experiences with Creature Chat, a cutting-edge mod that brings intelligent, dynamic conversation to Minecraft creatures! We harnesses the power of GPT (Generative Pre-trained Transformer) to make your world more interactive and communicative.",
+	"name": "CreatureChat",
+	"description": "Chat, befriend, and interact with a rich world of creatures like never before! All creatures can talk and respond naturally using AI.",
 	"authors": [
 		"Jonathan Thomas <jonathan@openshot.org>",
 		"owlmaddie <owlmaddie@gmail.com>"
@@ -36,8 +36,5 @@
 		"minecraft": "~1.20.2",
 		"java": ">=17",
 		"fabric-api": "*"
-	},
-	"suggests": {
-		"another-mod": "*"
 	}
 }