README.md edited online with Bitbucket
[swg-src.git] / USEFUL_COMMANDS.md
blob454de8ad5083a8f5bbc7b3bb5b8ae689085a13be
1 Small blurb about command syntax:
2     /command
3     
4     /command <argument you must specify> <>
5     
6     /command [optional argument you may not need to specify] []
7     
8     /command -parameter means you need to actually type -whatever -parameter
9     
10     /command [TARGET] simply means it must be your current target. [TARGET]
11     
12     /command <argument | argument2> means there is more than one option. Pick 1. | ARGUMENT |
13     
14     
15 #Enabling God Mode (Admin)
16 Note: Your localOptions.cfg file must have "adminGodToAll=1" in the [GameServer] section. Alternatively, if you would only like certain users to have access to the God Mode abilities, you can toggle that bool to 0 in localOptions and instead you will need to edit both the "qa_admin" and "us_admin" .tab files with the account username you'd like to have. Set their GodLevel to 55 for all commands and abilities, and their skill to "admin". Then compile it with the miff.exe tool. It is recommended that once you have compiled this file once, you only make future revisions with TRE Explorer as compiling the .tab document can get complex.
18 Once you have either globally enabled login or have enabled it for your account, login to the game and type:
20     /setGodMode
21     # Turns on God Mode
22     /setGodMode 50
23     # If you have adminGodToAll Enabled, do this instead.
24     /setGodMode off
25     # Disables the features of God Mode
26     
27 # Making Admin Commands Work In Your Client
28 You need to edit your user.cfg file and add the following:
29 (Note: You only need what's under [ClientGame], the UserInterface modifications just make everything so much easier.
31     [ClientGame]
32     0fd345d9 = true
33     [ClientUserInterface] 
34     debugExamine=1 
35     debugClipboardExamine=1 
36     allowTargetAnything=1 
37     drawNetworkIds=1
39 0fd345d9 enables the admin commands in your client. Without it your client will not send the commands to the server and will return the "no such command" error.
41 debugExamine allows you to /examine an object and get the ObjectID, and various other information like it's template.
43 debugClipboardExamine makes the debug info you get from /examine get placed on your clipboard so you can paste it with Ctrl+v
45 allowTargetAnything enables the ability to target objects like entire structures or objects you normally cannot to fix issues.
47 drawNetworkIds puts the ObjectID and NetworkID above every objects name.
50 # Basic God Mode Commands - Teleportation
52     /planetWarp <planet>
53     # Teleports you to the specified planet/terrain.
54     /planetWarpTarget <planet>
55     # Teleports your target to the specified planet/terrain.
56     /teleport <x> <z> <y>
57     # Teleports you to the specified coordinates on the current terrain.
58     /teleportTo <player>
59     # Teleports you to the specified player anywhere in the galaxy. 
60     /teleportTarget <x> <z> <y>
61     # Teleports your target to the specified coordinates on the current terrain.
62     /npeGoToMedicalBay
63     # Teleports your character to the opening medical bay instance (don't do with invulnerable on)
64     /npeGotoMilleniumFalcon
65     # Teleports your character to the opening millenium falcon instance.
66     /npeGoToStationGamma
67     # Teleports your character to Station Gamma.
68     /npeGoToTansariiStation
69     # Teleports your character to Tansarii Station.
71 # Basic God Mode Commands - Managing Your Character
73     /invulnerable
74     # Toggles Invulnerability - Makes your character invulnerable (removes health/action) and you appear as a NPC.
75     /aiIgnore
76     # Toggles aiIgnore - Artificial Intelligence ignore you (no aggro).
77     /setSpeed <speed>
78     # Changes the speed by which your character negotiates terrain. Recommended that you don't go higher than 5.
79     /getPlayerId <name>
80     # Returns the object ID (oid) of your character. This will be used frequently.
81     /object hide <oid> <bool>
82     # Hides your character from non God Mode characters. Set bool to 0 for visible and 1 for hidden. Make a macro for 0 and 1. It's easier. 
84 # Basic God Mode Commands - Managing Other Characters
86     /getAccountInfo <player FIRST name>
87     # Returns various account information about the specified character including their IP Address. They must be online.
88     /getStationName <player FIRST name>
89     # Returns the username of the specified player character. Does not work if player is offline.
90     /getPlayerId <player FIRST name>
91     # Returns the object ID (oid) of the specified player character. Does not work if player is offline.
92     /server getCharacterInfo <oid or player FIRST name>
93     # Returns Station ID, and Object ID of a character, even when they are offline. Along with other info.
94     /freezePlayer <player FIRST name>
95     # Freezes the player preventing them from moving. It's like being rooted.
96     /unfreezePlayer <player FIRST name>
97     # Reverses the effects of /freezePlayer
98     /squelch [TARGET]
99     # Prevents your target from talking, using mail, spatial, or tells. Must be your TARGET (don't type TARGET)
100     /unsquelch [TARGET]
101     # Reverses the effects of /squelch
102     /csDisconnectPlayer <player>
103     # Disconnects the specified player.
104     /kick <player FIRST name>
105     # Kicks the specified player from the server and returns them to the character screen.
106     /findPlayer <player name or partial name with *>
107     # Searches the galaxy for any players with matching names.
108     /cityInfo
109     # Displays an SUI window in which you can search and manage cities across the galaxy.
110     /listGuilds
111     # Spams your chat box with information on all active guilds of the galaxy.
112     /credits [-target] <cash | bank> <+|- value>
113     # Gives you (or optionally your target) the specified (or subtracts the specified) amount of credits from/to the bank or cash.
115 Attach QATool:
117     /script attach test.qatool <your network id>
118     
119 To see what QAtool can do:
120     
121     /qatool
122     
123 # Planet Persist
125 Set your localOptions.cfg to only have 1 persister thread and loadWholePlanets=1. Teleport to the planet you want to persist, attach the QATool, and as god, run
127     /qatool persistplanet <planetname>
128     
129 Once you have persisted all planets, shutdown the server and optionally remove the data/sku.0/sys.server/compiled/game/datatables/buildout/<planetname/*_ws.iff but only the ws files. You can then restart the server, optionally turning loadWholePlanet off to make it load faster and use less memory.
130 # Server Shutdown
132     /server shutdown 1 1 1 1
133     
134 # Spawn NPCs In Eisley Cantina
136     /script attach theme_park.tatooine.mos_eisley.masterspawner 1082874
138 # Testing
140     /setgodmode 50 
141     /getPlayerId <player first name only> 
142     /script attach test.qatool <id>
144 # Resteuss
146 * Find all the objects in the Imperial and Rebel base with ph1 attached to them, and run completeResteussStageOne on each (4830 80 5829 and 5900 81 5638 for the bases)
147 * Go to the center of Resteuss and find the ph1 marker, and execute startResteussStageTwo
148 * After Resteuss is fully spawned, create an object 400m away from /waypoint 5192.928223 77.937180 6074.740234 and use any random item to attach a script.
150     /script attach theme_park.restuss_event.pvp_region
152 * Make sure to also use the GM command /hide "objectID" 1to make the object non visible to player eg   /object hide 8762345533 1
154 # Spawning From Master Items table
156     dsrc/sku.0/sys.server/complied/game/datatables/item/master_item/master_item.tab 
157     /createStaticItem <id> 
158     /createStaticItem armor_stormtrooper_bicep_camo_l_04_01 
159     /object spawn object/tangible/terminal/terminal_character_builder.iff 
160     /object spawn heroic_echo_stormcommando 
162 # Beast Master
164     Isomerase- /object spawn object/tangible/loot/beast/enzyme_1.iff 
165     Lyase- /object spawn object/tangible/loot/beast/enzyme_2.iff 
166     Hydrolase- /object spawn object/tangible/loot/beast/enzyme_3.iff 
167     Pet Likes/dislikes showHappiness 
169 # Misc
171      Set objvar = /objvar set 
173 # User.cfg
175     [ClientUserInterface] 
176     debugExamine=1 
177     debugClipboardExamine=1 
178     allowTargetAnything=1 
179     drawNetworkIds=1