Update README.md
This commit is contained in:
@@ -1 +1,51 @@
|
||||
# SOR
|
||||
# SOR
|
||||
|
||||
## Resources
|
||||
|
||||
In addition to this gitea repository, the application's servers and webclient are deployed using containers using ArgoCD.
|
||||
- https://argo.aeternalisgames.com/
|
||||
|
||||
## Installation Instructions
|
||||
|
||||
### Visual Studio Code
|
||||
|
||||
Download any version of Visual Studio Code, from here:
|
||||
- https://code.visualstudio.com/download
|
||||
|
||||
### Godot Version 4.5.x
|
||||
|
||||
Download a version of Godot 4.5.x, preferrably Godot 4.5.2-stable, from here:
|
||||
- https://godotengine.org/download/archive/4.5.2-stable/
|
||||
|
||||
The Godot executable doesn't require an installation. Just unzip the godot folder and run the 'Godot_v4.5.2-stable_win64' executable.
|
||||
|
||||
## Clone Instructions
|
||||
|
||||
Only HTTPS clone to VSCode is supported at the moment.
|
||||
- SSH Clone doesn't work since the repository root doesn't have a .git folder.
|
||||
|
||||
On the "Code" page for SOR, click the "Code" button and then click "Open with VS Code".
|
||||
- Your browser may ask if you want to launch VS Code. Do so.
|
||||
- VS Code will utilize your browser to authenticate. Do so.
|
||||
|
||||
# The Client
|
||||
|
||||
The Client is a GUI created in Godot.
|
||||
|
||||
## Modifying the Client in Godot
|
||||
|
||||
Once you've cloned the repository, Open Godot.
|
||||
|
||||
Then, select "Import".
|
||||
|
||||
Open the project.godot file in the Client/origin-client/ folder.
|
||||
|
||||
## Building the Web Client
|
||||
|
||||
When you update the 'main' branch of the SOR Repository, a gitea action will automatically start, building the Godot Web Client.
|
||||
|
||||
## Deploying the Web Client
|
||||
|
||||
After the Web Client is built, you need to restart (not sync) the Deployment object of the sor-webclient application in ArgoCD.
|
||||
|
||||

|
||||
Reference in New Issue
Block a user