gemwright 0.0.0 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,71 @@
1
- # gemwright
1
+ # <img src=".github/small-forge.png" align="left" alt="Forge your own shard" width="50" height="50" /> Gemwright — Forge your own shard
2
2
 
3
- Forge your own shard.
3
+ ## Motivation
4
+
5
+ Gemwright makes it easier to start an Ultima Online shard and share it with friends. It brings emulator setup and Railway deployment into a small CLI, leaving more time to shape your world.
6
+
7
+ ## Setup
8
+
9
+ ### Sign up to Railway
10
+
11
+ Create a [Railway account](https://railway.com?referralCode=gokaygurcan) to host your shard. Using this affiliate link helps support Gemwright.
12
+
13
+ ### Install and authenticate Railway CLI
14
+
15
+ ```bash
16
+ npm i -g @railway/cli
17
+ railway login
18
+ ```
19
+
20
+ ### Install Gemwright CLI
21
+
22
+ ```bash
23
+ npm i -g gemwright
24
+ ```
25
+
26
+ ### Initialize a new shard
27
+
28
+ ```bash
29
+ # with questionnaire
30
+ gemwright init [directory]
31
+
32
+ # or with default values
33
+ gemwright init --yes
34
+ ```
35
+
36
+ ### Deploy to Railway
37
+
38
+ ```bash
39
+ # go into the project directory
40
+ gemwright deploy
41
+ ```
42
+
43
+ ```bash
44
+ # you need to provide your own game files, we do not ship them.
45
+ gemwright deploy --files /path/to/game-files
46
+ ```
47
+
48
+ ## Development
49
+
50
+ - [x] `init` to initialize shard with a few answers
51
+ - [x] `deploy` to deploy initialized shard to Railway
52
+ - - [x] to Railway
53
+ - - [ ] to VPS (Digital Ocean, Hetzner, etc.)
54
+ - [ ] Multiple server emulators
55
+ - - [x] ServUO [pub57]
56
+ - - [x] Sphere (with Script pack) [master]
57
+ - - [ ] RunUO
58
+ - - [ ] Sphere-X (with Script-X pack)
59
+ - - [ ] ModernUO
60
+ - - [ ] POL Server?
61
+ - - [ ] Moongate?
62
+ - - [ ] ???
63
+ - [ ] Web client
64
+
65
+ ## License
66
+
67
+ Gemwright is licensed under the [MIT License](LICENSE). Server emulators, script packs, dependencies, and game assets retain their respective licenses and terms.
68
+
69
+ ---
70
+
71
+ Gemwright is an independent project and is not affiliated with, endorsed by, or sponsored by Electronic Arts Inc. or Broadsword Online Games. Ultima Online is a trademark of Electronic Arts Inc. All other trademarks belong to their respective owners.