cleanup and document

projectawakening · Jan 5, 2024 · 6ac0dd2 · 6ac0dd2
1 parent aa7f489
commit 6ac0dd2
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 712 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,28 @@
 # Game Chain Contracts
 
 Disclaimer: This is very much a work in progess.
+
+# Development
+
+The development stack consists of:
+
+- An anvil node for etherum local development
+- Scripts deploying a mud world and all or selected modules for developments
+
+We are running the anvil node explicitly ourselves for three reasons:
+
+- Making the development environment as similar to live ones as possible
+- Decoupling from MUD's opinionated dev tools
+- Having a stand alone development node allows us to deploy modules in a deterministic an selective manner
+
+To start developing against the world and all of the CCP modules run:
+
+```
+./dev-all
+```
+
+You can also run
+
+```
+./dev module1,module2  # comma separated list of modules to load into the base world
+```
diff --git a/deployments/README.md b/deployments/README.md
@@ -0,0 +1,3 @@
+# Deployment configurations
+
+This directory contains deployment configurations for different environments or chains that we deploy worlds onto
diff --git a/deployments/mainnet/mainnet-config.json b/deployments/mainnet/mainnet-config.json
diff --git a/deployments/private-devnet/private-devnet-config.json b/deployments/private-devnet/private-devnet-config.json
diff --git a/deployments/public-testnet/public-testnet-config.json b/deployments/public-testnet/public-testnet-config.json
diff --git a/foundation/base-world/README.md b/foundation/base-world/README.md
@@ -0,0 +1,2 @@
+# Base mud world
+This module is the base world foundational module that will host the frontier world. With the current approach this does not deploy any system but rather creates the world itself. If there are systems that should be included in the world's inceptions we would add them here or in a separate foundational module.
diff --git a/foundation/base-world/script/PostDeploy.s.sol b/foundation/base-world/script/PostDeploy.s.sol
diff --git a/foundation/base-world/src/systems/TasksSystem.sol b/foundation/base-world/src/systems/TasksSystem.sol
diff --git a/foundation/base-world/test/TasksTest.t.sol b/foundation/base-world/test/TasksTest.t.sol
diff --git a/modules/smart-character/src/codegen/index.sol b/modules/smart-character/src/codegen/index.sol
diff --git a/modules/smart-character/src/codegen/world/IWorld.sol b/modules/smart-character/src/codegen/world/IWorld.sol
diff --git a/modules/smart-object-framework/src/codegen/index.sol b/modules/smart-object-framework/src/codegen/index.sol
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Deployment configurations

		This directory contains deployment configurations for different environments or chains that we deploy worlds onto
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Base mud world
		This module is the base world foundational module that will host the frontier world. With the current approach this does not deploy any system but rather creates the world itself. If there are systems that should be included in the world's inceptions we would add them here or in a separate foundational module.