Create README.md

README.md

@@ -0,0 +1,23 @@
+# Collavas Source Code
+
+**⚠️⚠️WARNING⚠️⚠️** **THIS CODE IS NOT SECURE AND IS VULNERABLE TO EXPLOITS, DO NOT USE FOR PRODUCTION**. This repository includes all the necessary files needed to host a collavas instance. All the code is a snapshot as it is on 3/5/2025.
+
+
+# About
+
+Collavas is a node application that combines the well known aspects of minecraft's 2b2t and reddit's r/place into one. Making it a canvas filled with anarchy, no moderation, no admin tools, free to draw anything within the 10000x10000 canvas that is rendered in HTML5 and with JS.
+
+## Setup
+
+To host your own instance, you want a version of Node and npm on either windows or linux and follow the steps below.
+
+- Run `git clone https://github.com/DrChic0/collavas-src.git` or download the repo as a zip for windows
+- Run `cd collavas-src` for windows unzip and go into the directory with terminal
+- Run `npm install` in terminal
+- Configure `config.yaml` file to run the port you want
+- Run `node server-96wMDN.js` for windows double click the collavas.bat file to run the latest server and client file available
+
+## Screenshots
+![image](https://github.com/user-attachments/assets/b11624ab-b7b3-49e4-bc05-6aedf549aeac)
+![image](https://github.com/user-attachments/assets/6d63a3c4-3140-4798-9594-da7df6b864d3)
+![image](https://github.com/user-attachments/assets/fd45f6bb-5dab-4b5d-8913-e58645179b9a)