TShock/docs/permission-descriptions.md
Lucas Nicodemus 270794ee69
Add field dump descriptions to docs
This adds the newly dumped field descriptions to the docs. In
particular, this adds field descriptions for the config file,
permissions, and ssc config. This also updates the sidebar with this
information.

The dumper formats have also been revamped for markdown.
2022-10-18 23:50:01 -07:00

14 KiB

tshock.accountinfo.details

Player can see advanced information about any user account.

  • Commands: None

tshock.ignore.sendtilesquare

Allow unrestricted SendTileSquare usage, for client side world editing.

  • Commands: None

tshock.ignore.dropbanneditem

Allow dropping banned items without the item being eaten.

  • Commands: None

tshock.annoy

User can annoy others.

  • Commands: /annoy, /rocket, /firework

tshock.admin.antibuild

User can set build protection status.

  • Commands: /antibuild

tshock.admin.ban

User can ban others.

  • Commands: /ban

tshock.world.time.bloodmoon

User can force a blood moon.

  • Commands: None

tshock.admin.broadcast

User can broadcast messages.

  • Commands: /broadcast (/bc /say)

tshock.buff.self

User can buff self.

  • Commands: /buff

tshock.buff.others

User can buff other players.

  • Commands: /gbuff (/buffplayer)

tshock.npc.butcher

User can kill all enemy npcs.

  • Commands: /butcher

tshock.ignore.ssc

Bypass server side character checks.

  • Commands: None

tshock.world.modify

User can modify the world.

  • Commands: None

tshock.account.changepassword

User can change password in game.

  • Commands: /password

tshock.canchat

Player can chat.

  • Commands: None

tshock.account.login

User can login in game.

  • Commands: /login

tshock.account.logout

User can logout in game.

  • Commands: /logout

tshock.world.paint

User can paint tiles.

  • Commands: None

tshock.partychat

User can use party chat in game.

  • Commands: /party (/p)

tshock.account.register

User can register account in game.

  • Commands: /register

tshock.thirdperson

User can talk in third person.

  • Commands: /me

tshock.projectiles.usebanned

Player can use banned projectiles.

  • Commands: None

tshock.tiles.usebanned

Player can place banned tiles.

  • Commands: None

tshock.cfg.password

User can edit the server password.

  • Commands: /serverpassword

tshock.cfg.reload

User can reload the configurations file.

  • Commands: /reload

tshock.accountinfo.check

Player can check if a username is registered and see its last login time.

  • Commands: /accountinfo (/ai)

tshock.clear

User can clear items or projectiles.

  • Commands: /clear

tshock.npc.clearanglerquests

User can clear the list of users who have completed an angler quest that day.

  • Commands: /clearangler

tshock.world.converthardmode

User can convert hallow into corruption and vice-versa.

  • Commands: None

tshock.cfg.createdumps

User can create reference files of Terraria IDs and the permission matrix in the server folder.

  • Commands: /dump-reference-data

tshock.tp.demonconch

User can use the Demon Conch.

  • Commands: None

tshock.world.time.dropmeteor

User can drop a meteor.

  • Commands: None

tshock.world.setdungeon

User can set the dungeon's location.

  • Commands: /setdungeon

tshock.world.time.eclipse

User can force an eclipse.

  • Commands: None

tshock.world.editregion

Allows you to edit regions.

  • Commands: None

tshock.world.editspawn

Allows you to edit the spawn.

  • Commands: /protectspawn

tshock.world.time.fullmoon

User can force a full moon.

  • Commands: None

tshock.tp.getpos

User can get the position of players.

  • Commands: /pos

tshock.item.give

User can give items.

  • Commands: /give (/g)

tshock.godmode

Player recovers health as damage is taken. Can be one shotted.

  • Commands: /godmode (/god)

tshock.godmode.other

User can godmode other players.

  • Commands: None

tshock.world.grow

User can grow plants.

  • Commands: /grow

tshock.world.growevil

User can grow evil biome plants.

  • Commands: None

tshock.world.sethalloween

User can force the server to Halloween mode.

  • Commands: /forcehalloween

tshock.world.hardmode

User can change hardmode state.

  • Commands: /hardmode

tshock.heal

User can heal players.

  • Commands: /heal

tshock.tp.home

User can use /home.

  • Commands: /home

tshock.npc.hurttown

User can hurt town NPCs.

  • Commands: None

tshock.ignore.damage

Prevents your actions from being ignored if damage is too high.

  • Commands: None

tshock.ignore.hp

Prevents you from being disabled by abnormal HP.

  • Commands: None

tshock.ignore.removetile

Prevents you from being reverted by kill tile abuse detection.

  • Commands: None

tshock.ignore.liquid

Prevents you from being disabled by liquid set abuse detection.

  • Commands: None

tshock.ignore.mp

Prevents you from being disabled by abnormal MP.

  • Commands: None

tshock.ignore.paint

Prevents you from being disabled by paint abuse detection.

  • Commands: None

tshock.ignore.placetile

Prevents you from being reverted by place tile abuse detection.

  • Commands: None

tshock.ignore.projectile

Prevents you from being disabled by projectile abuse detection.

  • Commands: None

tshock.ignore.itemstack

Prevents you from being disabled by stack hack detection.

  • Commands: None

tshock.admin.noban

Prevents you from being banned.

  • Commands: None

tshock.admin.nokick

Prevents you from being kicked.

  • Commands: None

tshock.npc.invade

User can start an invasion. Warning: high network use. Easy to abuse.

  • Commands: None

tshock.item.spawn

User can spawn items.

  • Commands: /item (/i)

tshock.journey.biomespreadfreeze

User can use Creative UI to stop the biome spread of the world.

  • Commands: None

tshock.journey.research

User can contribute research by sacrificing items

  • Commands: None

tshock.journey.godmode

User can use Creative UI to toggle character godmode.

  • Commands: None

tshock.journey.placementrange

User can use Creative UI to toggle increased placement range.

  • Commands: None

tshock.journey.rain.freeze

User can use Creative UI to stop the world rain strength from changing.

  • Commands: None

tshock.journey.rain.strength

User can use Creative UI to set world rain strength/seed.

  • Commands: None

tshock.journey.setdifficulty

User can use Creative UI to set world difficulty/mode.

  • Commands: None

tshock.journey.setspawnrate

User can use Creative UI to set the NPC spawn rate of the world.

  • Commands: None

tshock.journey.time.freeze

User can use Creative UI freeze time.

  • Commands: None

tshock.journey.time.set

User can use Creative UI to set world time.

  • Commands: None

tshock.journey.time.setspeed

User can use Creative UI to set world time speed.

  • Commands: None

tshock.journey.wind.freeze

User can use Creative UI to stop the world wind strength from changing.

  • Commands: None

tshock.journey.wind.strength

User can use Creative UI to set world wind strength/seed.

  • Commands: None

tshock.admin.kick

User can kick others.

  • Commands: /kick

tshock.kill

User can kill others.

  • Commands: /kill (/slay)

tshock.admin.viewlogs

Specific log messages are sent to users with this permission.

  • Commands: /displaylogs

tshock.tp.magicconch

User can use the Magic Conch.

  • Commands: None

tshock.cfg.maintenance

User is notified when an update is available, user can turn off / restart the server.

  • Commands: /checkupdates, /off (/exit /stop), /off-nosave (/exit-nosave /stop-nosave), /version

tshock.world.events.bloodmoon

User can use the 'bloodmoon' subcommand of the 'worldevent' command

  • Commands: None

tshock.world.events.eclipse

User can use the 'eclipse' subcommand of the 'worldevent' command

  • Commands: None

tshock.world.events

User can use the 'worldevent' command

  • Commands: /worldevent

tshock.world.events.fullmoon

User can use the 'fullmoon' subcommand of the 'worldevent' command

  • Commands: None

tshock.admin.group

User can manage groups.

  • Commands: /group

tshock.world.events.invasion

User can use the 'invasion' subcommand of the 'worldevent' command

  • Commands: None

tshock.admin.itemban

User can manage item bans.

  • Commands: /itemban

tshock.world.events.lanternsnight

User can use the 'lanternsnight' subcommand of the 'worldevent' command

  • Commands: None

tshock.world.events.meteor

User can use the 'meteor' subcommand of the 'worldevent' command

  • Commands: None

tshock.admin.projectileban

User can manage projectile bans.

  • Commands: /projban

tshock.world.events.rain

User can use the 'rain' subcommand of the 'worldevent' command

  • Commands: None

tshock.admin.region

User can manage regions.

  • Commands: /region

tshock.world.events.sandstorm

User can use the 'sandstorm' subcommand of the 'worldevent' command

  • Commands: None

tshock.admin.tileban

User can manage tile bans.

  • Commands: /tileban

tshock.admin.warp

User can manage warps.

  • Commands: None

tshock.npc.maxspawns

User can edit the max spawns.

  • Commands: /maxspawns

tshock.world.movenpc

User can change the homes of NPCs.

  • Commands: None

tshock.admin.mute

User can mute and unmute users.

  • Commands: /mute (/unmute)

tshock.tp.pylon

User can use pylons to teleport

  • Commands: None

tshock.world.rain

User can turn on or off the rain.

  • Commands: None

tshock.npc.rename

User can rename NPCs.

  • Commands: /renamenpc

tshock.reservedslot

Allows you to bypass the max slots for up to 5 slots above your max.

  • Commands: None

tshock.respawn

Player can respawn themselves.

  • Commands: /respawn

tshock.respawn.other

Player can respawn others.

  • Commands: None

tshock.tp.rod

User can use the Rod of Discord.

  • Commands: None

tshock.world.sandstorm

User can turn on or off sandstorms.

  • Commands: None

tshock.admin.savessi

User can save all the players SSI (server side character) state.

  • Commands: /overridessc (/ossc), /savessc

tshock.admin.seeplayerids

User can see the id of players with /who.

  • Commands: None

tshock.sendemoji

Player can send emotes.

  • Commands: None

tshock.info

User can get the server info.

  • Commands: /serverinfo

tshock.admin.tempgroup

User can elevate other users' groups temporarily.

  • Commands: /tempgroup

tshock.slap

User can slap others.

  • Commands: /slap

tshock.tp.spawn

User can use /spawn.

  • Commands: /spawn

tshock.npc.spawnboss

User can spawn bosses.

  • Commands: /spawnboss (/sb)

tshock.npc.spawnmob

User can spawn npcs.

  • Commands: /spawnmob (/sm)

tshock.npc.spawnpets

User can spawn pets. Warning: high network use. Easy to abuse.

  • Commands: None

tshock.npc.spawnrate

User can edit the spawnrate.

  • Commands: /spawnrate

tshock.npc.startdd2

User can start the dd2 event.

  • Commands: None

tshock.npc.startinvasion

User can start invasions (Goblin/Snow Legion) using items.

  • Commands: None

tshock.su

Allows a user to elevate to superadmin for 10 minutes.

  • Commands: /su, /sudo

tshock.npc.summonboss

User can summon bosses using items.

  • Commands: None

tshock.synclocalarea

Player can resync themselves with server state.

  • Commands: /sync

tshock.world.time.set

User can set the time.

  • Commands: /time

tshock.world.toggleexpert

User can change expert state.

  • Commands: /worldmode (/gamemode)

tshock.world.toggleparty

Player can toggle party event.

  • Commands: None

tshock.tp.self

User can teleport to others.

  • Commands: /tp

tshock.tp.allothers

User can teleport everyone to them.

  • Commands: None

tshock.tp.block

Users can stop people from teleporting.

  • Commands: /tpallow

tshock.tp.npc

User can teleport to an NPC.

  • Commands: /tpnpc

tshock.tp.others

User can teleport other people.

  • Commands: /tphere

tshock.tp.override

Users can override teleport blocks.

  • Commands: None

tshock.tp.pos

User can teleport to tile positions.

  • Commands: /tppos

tshock.tp.tppotion

User can use Teleportation Potions.

  • Commands: None

tshock.tp.silent

Users can teleport to people without showing a notice

  • Commands: None

tshock.ssc.upload

User can upload their joined character data as SSC data.

  • Commands: /uploadssc

tshock.ssc.upload.others

User can upload other players join data to the SSC database.

  • Commands: None

tshock.item.usebanned

Allows you to use banned items.

  • Commands: None

tshock.superadmin.user

Meant for super admins only.

  • Commands: /user

tshock.admin.userinfo

User can get other users' info.

  • Commands: /userinfo (/ui)

tshock.world.time.usesundial

Player can use the Enchanted Sundial item.

  • Commands: None

tshock.warp

User can use warps.

  • Commands: /warp

tshock.whisper

User can whisper to others.

  • Commands: /reply (/r), /whisper (/w /tell /pm /dm), /wallow (/wa)

tshock.cfg.whitelist

User can modify the whitelist.

  • Commands: /whitelist

tshock.world.wind

User can modify the wind.

  • Commands: /wind

tshock.world.info

User can get the world info.

  • Commands: /worldinfo

tshock.world.save

User can save the world.

  • Commands: /save

tshock.world.settleliquids

User can settle liquids.

  • Commands: /settle

tshock.world.setspawn

User can set the world spawn.

  • Commands: /setspawn

tshock.tp.wormhole

User can use wormhole potions.

  • Commands: None

tshock.world.setxmas

User can force the server to Christmas mode.

  • Commands: /forcexmas