Skip to content

Commit 2371f92

Browse files
authored
Update README.md
1 parent cc3c23d commit 2371f92

File tree

1 file changed

+74
-25
lines changed

1 file changed

+74
-25
lines changed

README.md

Lines changed: 74 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,107 @@ Because the mod is in alpha, it lacks many features like permissions configurati
88

99
**Keep in mind, worlds and portals must be created by a server operator**.
1010

11-
# How to use Quantum
11+
## How to use Quantum
1212

1313
Bellow you are going to learn how to use Quantum.
1414

15-
- All command arguments that are in **BOLD** are required.
16-
- All command arguments are suggested in game as you type, so don't worry about not being sure about what you should write.
15+
- All command arguments that are between **[]** are required.
16+
- All command arguments that are between **()** are optional.
1717

1818
# How to create a new world
1919

20-
To create a new world, you must be a server operator and use the following command:
20+
```
21+
/qt createworld [worldName] (difficulty) (worldDimension)
22+
```
2123

22-
/quantum create world <**worldName**> <_difficulty_> <_worldDimension_>
24+
Arguments:
25+
- **worldName**: The name of your world.
26+
- **difficulty**: The difficulty setting for your world (e.g., peaceful, easy, normal, hard).
27+
- **worldDimension**: The dimension type for your world (e.g., overworld, nether, end, or a custom dimension from another mod).
2328

24-
Arguments:
25-
- **worldName** : The name of your world.
26-
- _difficulty_ : The difficulty of your world.
27-
- _worldDimension_ : The dimension of your world. (eg. overworld, end, nether)
29+
Note:
30+
- Once the world is created, it will automatically load when the server starts.
31+
- The world’s configurations are stored in a file called quantum.dat located in the data directory of your world.
2832

29-
When a world is created, it will be automaticly loaded when the server starts.
30-
The worlds configurations are saved in the config directory config/quantum/worlds.
33+
# How to delete a world
3134

32-
# How to create a portal
35+
```
36+
/qt deleteworld [worldName]
37+
```
38+
39+
Arguments:
40+
- **worldName**: The name of your world.
3341

34-
To create a portal, you must be a server operator and use the following command:
42+
Note:
43+
- This command will permanently delete the specified world, including all data and files associated with it.
44+
- Make sure you have a backup if you want to keep any information from that world!
3545

36-
**NOTE: If you want your portal to go to a new world, you have to use the command above to create a new world before creating a portal**
46+
# How to change the spawn point of a world
3747

38-
/quantum create portal <**worldDestination**> <**portalFrameBlock**> <**portalActivationItem**> <**portalColor**>
48+
```
49+
/qt setworldspawn
50+
```
3951

40-
Arguments:
41-
- **worldDestination** : The destination of your portal.
42-
- **portalFrameBlock** : The block that your portal will be built with (Only solid and full blocks).
43-
- **portalActivationItem** : The item to use to activate the portal (items, water and lava are supported).
44-
- **portalColor** : The color of the portal.
52+
This command sets the spawn point of the world to your current location, using your player’s position, yaw, and pitch (the direction you’re facing)
53+
54+
Note:
55+
- While Minecraft has a similar command, it is limited to the Overworld. This command works in any dimension, providing more flexibility
4556

46-
# How to teleport to different worlds without a portal
57+
# How to teleprot using commands
4758

48-
Actually only server operators can do that with the following command:
59+
```
60+
/qt tp [worldName]
61+
```
4962

50-
/quantum tp <**worldIdentifier**>
63+
# How to teleport using signs
64+
65+
To set a destination, simply look at a sign and use the following command
66+
67+
```
68+
/qt setdestination
69+
```
70+
71+
Note:
72+
- The back of the sign will automatically store the information about the destination world
73+
- You can still freely edit the front of the sign to display any message or decoration you like
74+
75+
# How to create a portal
76+
77+
**IMPORTANT: If you want your portal to go to a new world, you have to use the command above to create a new world before creating a portal**
78+
79+
```
80+
/qt createportal [portalFrameBlock] [portalIgniteItem] [portalDestinationWorldName]
81+
```
82+
83+
Arguments:
84+
- **portalFrameBlock** : The block type used to build the portal frame (only solid, full blocks are supported)
85+
- **portalIgniteItem** : The item required to activate the portal (can be items, water, or lava)
86+
- **portalActivationItem** : The item to use to activate the portal (items, water and lava are supported).
87+
88+
# How to delete a portal
89+
90+
```
91+
/qt deleteportal [portalFrameBlock]
92+
```
5193

5294
Arguments:
53-
- **worldIdentifier** : The identifier of the world where you want to go.
95+
- **portalFrameBlock** : The block type used to build the portal frame.
96+
97+
Note:
98+
- After deleting a portal, it’s recommended to restart the server for the changes to fully take effect
99+
- Deleted portals will not be physically destroyed. Instead, they will simply stop functioning
54100

55101
# Whats next ?
56102

57-
I already planned to add mod configuration, teleporting to worlds by right clicking signs.
103+
Thoses features are already planned:
104+
- Custom portal color
58105

59106
# A last word
107+
60108
This mod is mainly created for my personal use, i may or may not update it regulary. I'll still try to maintains it updated to the last minecraft version.
61109

62110
# Thanks
111+
63112
[CustomPortalAPI](https://github.com/kyrptonaught/customportalapi) : I use this lib for creating custom portals.
64113

65114
[Fantasy](https://github.com/NucleoidMC/fantasy) : I use this lib for creating worlds at runtime.

0 commit comments

Comments
 (0)