Mirrored_Repos/awesome-lego-universe
1
0
Fork 0
mirror of https://github.com/EliteMasterEric/awesome-lego-universe.git synced 2024-11-21 21:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from Marcono1234/formatting-improvements

Browse Source 
Fix typos and improve formatting
This commit is contained in:
Eric Myllyoja 2022-01-01 16:30:20 -05:00 committed by GitHub
commit 166ea1a888
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 80 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,4 +1,4 @@
# Awesome Lego Universe
# Awesome LEGO Universe
![](images/splash-art.jpg)

12
mythrans-bible.md
View File

@ -29,7 +29,7 @@ Players have a max GM level and a current GM level; at any time, a player can us
A player with full GM permissions can lower themselves down to 0 to play the game as though they were a normal player, then raise their level up if they need to do something like teleport or unstuck themselves. Think of it like Minecraft; if you have permissions, you can play the game in Survival, and call `/gamemode creative` only when you get stuck.
There are 10 total levels, as follows|
There are 10 total levels, as follows:
* 0 - Civilian: This level describes all normal players of the game.
- Players at this level still have access some commands, see the Console Commands section below.
@ -61,7 +61,7 @@ There are 10 total levels, as follows|
Here is a list of all console commands, grouped by required permission level. Each level also has access to the commands of the levels above them. To run one of these console comands, enter them into chat.
Values in `<brackets>` represent necessary parameters, values in `(parens)` represnt optional parameters.
Values in `<brackets>` represent necessary parameters, values in `(parens)` represent optional parameters.
### WORK IN PROGRESS
@ -79,7 +79,7 @@ This system functions similarly to Terraria's PvP system; you must enable PvP in
#### /playanimation <anim-name>
This command triggers the player to play an animation with the given internal name. This can look somewhat buggy, since any player animation can be played, such as attacks that don't match your current gear, but isn't that part of the fun if it?
This command triggers the player to play an animation with the given internal name. This can look somewhat buggy, since any player animation can be played, such as attacks that don't match your current gear, but isn't that part of the fun of it?
**TODO: Add a curated list of some fun animations.**
@ -388,10 +388,12 @@ Grants a specified buff for a given duration.
#### /testmap <zone> (force)
Attempt to transport the player to the given world.
Attempt to transport the player to the given zone.
Use `/testmap <zone> force` to forcibly teleport to a potentially invalid zone. Can have disastrous results.
See [Available Zone IDs](#available-zone-ids) for a list of zone IDs you can use.
#### /createprivate
**TODO: What does this do? Does it have to do with `/join` ?**
@ -422,6 +424,8 @@ Activate one or more spawners by name.
#### /inspect
**TODO: What does this do?**
#### /reforge <base> <target>
Attempts to create a "reforged" item, which has the appearance of one item and the stats of another.

111
server-setup/google-cloud-setup.md
View File

@ -11,9 +11,9 @@ The downside to this method is that it does technically cost money. You may have
## Setup Client Files
The first step in this process is setting up your client files. You will need a Lego Universe 1.10.64 client before continuing. Note that a link to a client cannot be provided in this guide for legal reasons, but Google should be able to help you.
The first step in this process is setting up your client files. You will need a LEGO Universe 1.10.64 client before continuing. Note that a link to a client cannot be provided in this guide for legal reasons, but Google should be able to help you.
Once you've obtained a client, [make sure it is good by validating the checksum](verify-my-client.md).
Once you've obtained a client, [make sure it is good by validating the checksum](/verify-my-client.md).
## Unpack Client Files
@ -62,24 +62,27 @@ Finally, right click your `server-resources` folder, and select 'Send to...' > '
## Getting Started with Google Cloud
Google makes it very easy to set up a server instance in the cloud. First, [sign up for an account with Google Cloud](https://cloud.google.com/). You should see this popup to let you know you've received $300 in trial credits:
Google makes it very easy to set up a server instance in the cloud.
![](../images/google-cloud-trial.png)
1. First, [sign up for an account with Google Cloud](https://cloud.google.com/). You should see this popup to let you know you've received $300 in trial credits:
Then, you can access your cloud account from the [Google Cloud Console](https://console.cloud.google.com/). Google has a LOT of powerful tools and resources, but most of them are designed for larger businesses and not relevant to this guide, so don't get overwhelmed.
![](../images/google-cloud-trial.png)
Click on the `Compute Engine` tab, and then click on the `Create Instance` button to create a new VM instance.
2. Then, you can access your cloud account from the [Google Cloud Console](https://console.cloud.google.com/). Google has a LOT of powerful tools and resources, but most of them are designed for larger businesses and not relevant to this guide, so don't get overwhelmed.
![](../images/google-cloud-compute.png)
3. Click on the `Compute Engine` tab, and then click on the `Create Instance` button to create a new VM instance.
![](../images/google-cloud-create.png)
![](../images/google-cloud-compute.png)
* Name it `darkflame-instance`.
* The default regon and zone are fine.
* Select the machine type. The default is a 2-core, 4GB memory machine, which is way overkill for what we want. Select the series N1, machine type `f1-micro`, which at time of writing is currently priced at $4.88/month or $0.01/hour. Even this is more than what you need for a DLU server but smaller instances aren't available.
* Scroll to the bottom and click Create.
---
Once the instance is ready, click it, then click SSH to connect to your instance. You will then see a browser window containing a terminal.
![](../images/google-cloud-create.png)
4. Name it `darkflame-instance`.
5. The default region and zone are fine.
6. Select the machine type. The default is a 2-core, 4GB memory machine, which is way overkill for what we want. Select the series N1, machine type `f1-micro`, which at time of writing is currently priced at $4.88/month or $0.01/hour. Even this is more than what you need for a DLU server but smaller instances aren't available.
7. Scroll to the bottom and click Create.
8. Once the instance is ready, click it, then click SSH to connect to your instance. You will then see a browser window containing a terminal.
Congratulations! What you've essentially done is reserve a tiny spot on Google's massive server farm, and created a Linux computer in it. We're going to build and install Darkflame Universe on here, and you and your friends will be able to connect and play the game.
@ -144,53 +147,55 @@ Wait until the build process is complete. This will take a while. In the meantim
Next, we're going to upload the resources folder [we created earlier](#setup-resource-directory) to the proper location. In order to do this in a way that doesn't differ between computers, we're going to create a Google Cloud Storage bucket and upload the files to it.
* Click 'Google Cloud Platform' at the top to move to the Google Cloud homepage.
* Click 'Cloud Storage' on the left.
* Click 'Create Bucket' at the top.
* Pick a name that is easy to remember and easy to type. It needs to be GLOBALLY unique apparently.
* Stick with the defaults for region, storage class, access control, and protection.
1. Click 'Google Cloud Platform' at the top to move to the Google Cloud homepage.
2. Click 'Cloud Storage' on the left.
3. Click 'Create Bucket' at the top.
4. Pick a name that is easy to remember and easy to type. It needs to be GLOBALLY unique apparently.
5. Stick with the defaults for region, storage class, access control, and protection.
Now the bucket is created, you will see the details page for that bucket and a list of objects (i.e. files) in it.
Now the bucket is created, you will see the details page for that bucket and a list of objects (i.e. files) in it.
Click 'Upload File', select your `server-resources` ZIP, and click upload. This process should take just a second.
6. Click 'Upload File', select your `server-resources` ZIP, and click upload. This process should take just a second.
## Configuring the Server's Firewall
Before we get started building the server, we need to configure the server's firewall. Follow these steps:
* Click 'Compute Engine' to move back to the Compute Engine homepage.
* Under Related Actions, click 'Set up Firewall rules'
* Click 'Create Firewall Rule' at the top.
1. Click 'Compute Engine' to move back to the Compute Engine homepage.
2. Under Related Actions, click 'Set up Firewall rules'
3. Click 'Create Firewall Rule' at the top.
We're going to create a set of Firewall rules that allow access to the server.
* Set the name to `darkflame-server`.
* Add `darkflame-server` to the list of target tags. We're going to assign this tag to our server later.
* Set the Source IPv4 ranges to `0.0.0.0/0`. This represents all IP addresses, meaning this rule will allow any incoming IP.
* Under Protocols and ports, check `TCP` and enter the string `1001, 2000, 2005, 3000-4000, 3306, 5000`. This will allow access to the auth server, master server, chat server, world servers, database, and account manager.
* Under Protocols and ports, check `UDP` and enter the string `1001, 2000, 2005, 3000-4000, 3306, 5000`.
1. Set the name to `darkflame-server`.
2. Add `darkflame-server` to the list of target tags. We're going to assign this tag to our server later.
3. Set the Source IPv4 ranges to `0.0.0.0/0`. This represents all IP addresses, meaning this rule will allow any incoming IP.
4. Under Protocols and ports, check `TCP` and enter the string `1001, 2000, 2005, 3000-4000, 3306, 5000`. This will allow access to the auth server, master server, chat server, world servers, database, and account manager.
5. Under Protocols and ports, check `UDP` and enter the string `1001, 2000, 2005, 3000-4000, 3306, 5000`.
Now lets assign these rules to the server.
* Move back to the home of your Google Cloud project (which currently contains your cloud instance).
1. Move back to the home of your Google Cloud project (which currently contains your cloud instance).
![](../images/google-cloud-back-to-home.png)
![](../images/google-cloud-back-to-home.png)
* Click 'Compute Engine'. You should see your `darkflame-instance` listed. Click on it.
2. Click 'Compute Engine'. You should see your `darkflame-instance` listed. Click on it.
![](../images/google-cloud-compute.png)
![](../images/google-cloud-compute.png)
![](../images/google-cloud-click-instance.png)
---
* Click 'Edit' at the top.
![](../images/google-cloud-click-instance.png)
![](../images/google-cloud-click-edit.png)
3. Click 'Edit' at the top.
* Scroll down to 'Network tags' and enter `darkflame-server`.
![](../images/google-cloud-click-edit.png)
![](../images/google-cloud-add-network-tag.png)
4. Scroll down to 'Network tags' and enter `darkflame-server`.
* Scroll to the bottom and click 'Save'.
![](../images/google-cloud-add-network-tag.png)
5. Scroll to the bottom and click 'Save'.
## Setup the Server
@ -290,10 +295,10 @@ That's it! You're done! Your server is online. You can find your IP on the Cloud
Now that you are running a server, you should follow these steps:
* Go to your web browser, and navigate to `http://<IP-ADDRESS>:5000/dashboard`, where `<IP-ADDRESS>` is the IP address of your server.
* You will see a login. Enter the Mythran credentials you entered earlier.
* You will be redirected to the dashboard. Enter a number of keys to generate, and click `Generate`.
* You will see a list of CD keys. Give one of these keys to each player you want to join.
1. Go to your web browser, and navigate to `http://<IP-ADDRESS>:5000/dashboard`, where `<IP-ADDRESS>` is the IP address of your server.
2. You will see a login. Enter the Mythran credentials you entered earlier.
3. You will be redirected to the dashboard. Enter a number of keys to generate, and click `Generate`.
4. You will see a list of CD keys. Give one of these keys to each player you want to join.
To allow a player to join, give them one of these CD keys, and tell them to go to `http://<IP-ADDRESS>:5000/activate` and create an account.
@ -303,7 +308,7 @@ Once they have an account, the player should be able to change their client's `b
## Updating Darkflame Universe
In the future, updates will be release to DarkflameServer that will include bug fixes and potentially even new features. To update the server, you can run the following commands, in order:
In the future, updates will be released to DarkflameServer that will include bug fixes and potentially even new features. To update the server, you can run the following commands, in order:
```
# Shut down the server.
@ -324,22 +329,22 @@ Backing up your database is a good idea, as it will allow you to recover your da
1. Run the following command on your server, then enter your database password.
```bash
mysqldump -u darkflame darkflame --result-file=$HOME/dump.sql -p
```
```bash
mysqldump -u darkflame darkflame --result-file=$HOME/dump.sql -p
```
2. The complete contents of your server's database will be output to the file `~/dump.sql`. This is including, but not limited to:
* Accounts, including usernames and (encrypted) passwords.
* Characters, including their inventory, stats, mission progress, and other data.
* Activity logs, including login and logout times for each player.
* Minigame leaderboards, including scores and times for each player.
* Accounts, including usernames and (encrypted) passwords.
* Characters, including their inventory, stats, mission progress, and other data.
* Activity logs, including login and logout times for each player.
* Minigame leaderboards, including scores and times for each player.
3. To get the dump file off the server, run the following command. This will place the file on the Google Cloud Storage instance you created to upload the server-resources file.
```bash
gsutil cp dump.sql gs://BUCKETNAME/dump.sql
```
```bash
gsutil cp dump.sql gs://BUCKETNAME/dump.sql
```
If the last step fails, see the [Google Cloud Setup Troubleshooting](google-cloud-troubleshooting.md) page.

2
server-setup/google-cloud-troubleshooting.md
View File

@ -27,7 +27,7 @@ This error occurs when the instance's service account does not have the correct
Follow the steps below to configure the instance:
1. Go to the Google Cloud Console and navigate to the Compute Engine tab.
2. Select the instance and click `Stop`. This will temporarily shut down the server and stop the instance. You will be ablt to start it back up later.
2. Select the instance and click `Stop`. This will temporarily shut down the server and stop the instance. You will be able to start it back up later.
3. Click the instance name in the list of instances to open up the details page, then click `Edit` at the top.
4. Scroll down to the subheading named `Access scopes` and select `Allow full access to all Cloud APIs`.
5. Click `Save` to save the changes.

24
verify-my-client.md
View File

@ -1,6 +1,6 @@
# Verifying My Client
So you've just downloaded what appears to be a Lego Universe client, but you don't know if it's the right one. Maybe it's too old? Is the download corrupted? Or worse, what if it's actually a virus?
So you've just downloaded what appears to be a LEGO Universe client, but you don't know if it's the right one. Maybe it's too old? Is the download corrupted? Or worse, what if it's actually a virus?
Thankfully, there's a foolproof method to verify a client: Checksums.
@ -12,13 +12,13 @@ A checksum function is a procedure which takes some input data and generates an
The important thing to know is that if the input data is even the tiniest bit different, it will completely change the output string. See below.
![](images/checksum.png)
![Checksum explanation image](images/checksum.png)
By the nature of the checksum function, it is basically impossible to intentionally create a file that even resembles, much less exactly matches, a given checksum. For SHA-256 (the checksum function we will be using in this guide), the odds that two files will have the same checksum is approximately...
1 in 4,300,000,000,000,000,000,000,000,000,000,000,000,000,000,000,000,000,000,000,000
Add on top of that the odds that the file isn't a garbled mess, on top of the odds that the file resembles a Lego Universe client...
Add on top of that the odds that the file isn't a garbled mess, on top of the odds that the file resembles a LEGO Universe client...
## Basic Steps
@ -44,9 +44,9 @@ With how useful taking the checksum of a file is, it's really something that Win
1. Open a command line terminal (cmd.exe).
2. Run the following command, replacing `<file>` with the path to your client.
```
certutil -hashfile <file> SHA256
```
```
certutil -hashfile <file> SHA256
```
3. The command will output a long string of characters.
- Compare it to make sure it matches one of the ones above.
- If your client is out-of-date, corrupted, or potentially malicious, the SHA256 checksum will significantly differ from the ones above.
@ -55,9 +55,9 @@ certutil -hashfile <file> SHA256
1. Open a command line terminal.
2. Run the following command, replacing `<file>` with the path to your client.
```
shasum -a 256 <file>
```
```
shasum -a 256 <file>
```
3. The command will output a long string of characters.
- Compare it to make sure it matches one of the ones above.
- If your client is out-of-date, corrupted, or potentially malicious, the SHA256 checksum will significantly differ from the ones above.
@ -66,9 +66,9 @@ shasum -a 256 <file>
1. Open a command line terminal.
2. Run the following command, replacing `<file>` with the path to your client.
```
shasum -a 256 <file>
```
```
shasum -a 256 <file>
```
3. The command will output a long string of characters.
- Compare it to make sure it matches one of the ones above.
- If your client is out-of-date, corrupted, or potentially malicious, the SHA256 checksum will significantly differ from the ones above.