diff --git a/README.md b/README.md index 95198f6..1c754a2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Dialogue Dreamland 🤖💬 +# 🤖 Dialogue Dreamland 💬 Dialogue Dreamland is a Unity project that uses [ChatGPT](https://openai.com/blog/chatgpt/) to give NPCs unique personalities in a WebGL build designed for browser use. @@ -20,20 +20,20 @@ Dialogue Dreamland is a Unity project that uses [ChatGPT](https://openai.com/blo
🚧 This project is a work in progress 🚧 -# Table of Contents -- [Introduction](#introduction) -- [Showcase](#showcase) -- [Installation](#installation) -- [Upcoming Features](#upcoming-features) -- [Future Ideas](#future-ideas) -- [Contribution Guidelines](#contribution-guidelines) -- [Credits](#credits) -- [License](#license) - -# Introduction +# 📖 Table of Contents +- [🚀 Introduction](#🚀-introduction) +- [🎥 Showcase](#🎥-showcase) +- [⚙️ Installation](#⚙️-installation) +- [🗓️ Upcoming Features](#🗓️-upcoming-features) +- [💡 Future Ideas](#💡-future-ideas) +- [🤝 Contribution Guidelines](#🤝-contribution-guidelines) +- [🏅 Credits](#🏅-credits) +- [📝 License](#📝-license) + +# 🚀 Introduction Welcome to Dialogue Dreamland, an immersive and innovative Unity project that harnesses the power of OpenAI's ChatGPT to breathe life into non-player characters (NPCs) in a WebGL build accessible right from your browser. By integrating state-of-the-art natural language processing technology, this project delivers engaging, interactive dialogues and unique NPC personalities, creating a dynamic and captivating gaming experience unlike any other. Dive into the world of Dialogue Dreamland and witness the fusion of artificial intelligence and game development come alive. -# Showcase +# 🎥 Showcase This section highlights some of the key technical features and design choices that make Dialogue Dreamland a unique and engaging project. ## ChatGPT Integration @@ -58,7 +58,7 @@ The project uses [Unity's JavaScript Interop](https://docs.unity3d.com/Manual/we ## Tools This project includes a submodule, [ChatGPTWrapper](https://github.com/p-v-z/ChatGPT-Wrapper-For-Unity), a fork of [ChatGPT-Wrapper-For-Unity](https://github.com/GraesonB/ChatGPT-Wrapper-For-Unity) - which is a wrapper for the [ChatGPT API](https://openai.com/blog/chatgpt/) that allows you to use it in Unity. -# Installation +# ⚙️ Installation ## Prerequisites - Unity version [2021.3.20f1](./ProjectSettings/ProjectVersion.txt) or higher 🎮 @@ -94,7 +94,7 @@ Clone [ChatGPTWrapper](https://github.com/p-v-z/ChatGPT-Wrapper-For-Unity) (or a You should now be able to open the project and run it in the Unity Editor. If you have any issues, please feel free to reach out. -# Upcoming Features +# 🗓️ Upcoming Features - World UX - Fix colliders and layers so that camera doesn't clip through the floor or walls. - When you exit conversation, NPC should wave as it generates a 'goodbye' response. @@ -104,17 +104,17 @@ You should now be able to open the project and run it in the Unity Editor. If yo - Make AI more human-like - Make them move around every now and then, maybe have a sit on the bench animation -# Future Ideas +# 💡 Future Ideas - Make dialogue trigger changes in the world. For example, and NPC can serve as a guard to a door, and if you convince them to let you through, the door will open. - Add a 'memory' system, where you can recall past conversations with NPCs. -# Contribution Guidelines +# 🤝 Contribution Guidelines If you would like to contribute to this project, please feel free to fork the repository and submit a pull request. If you have any questions, please feel free to reach out. -# Credits +# 🏅 Credits At the core of this project sits [ChatGPTWrapper](https://github.com/p-v-z/ChatGPT-Wrapper-For-Unity), which is a fork of [GraesonB](https://github.com/GraesonB)'s project - grattitude to them 🙏. -# License +# 📝 License This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.