# Teleport Commands <img alt="Teleport Commands Logo" src="https://raw.githubusercontent.com/MrSn0wy/TeleportCommands/main/common/src/main/resources/teleport_commands.png" width="30"/>

A Minecraft server-side mod that adds various teleportation related commands, like /home /tpa and /back

Here is the [Changelog](https://github.com/MrSn0wy/TeleportCommands/blob/main/CHANGELOG.md)

## Currently available commands:

- `/worldspawn [<Disable Safety>]` - Teleports you to the world spawn (in the overworld), if given true it will not do safety checks
- `/back [<Disable Safety>]` -  Teleports you to the location where you last died, if given true it will not do safety checks
<br><br>
    **Homes are player specific locations that only that player can teleport to**
- `/sethome <name>` - Creates a new home
- `/home [<name>]` - Teleports you to the home, if no name is giving it will go to the default home
- `/delhome <name>` - Deletes a home
- `/renamehome <name> <newName>` - Renames a home
- `/homes` - Shows a list of your homes
- `/defaulthome <name>` - Sets the default home
<br><br>
    **Warps are op managed locations that all players can teleport to**
- `/warp <name>` - Teleports you to the warp
- `/warps` - Shows a list of the available warp
- `/setwarp <name>` - Sets a warp. Permission level of 4 required (op)
- `/delwarp <name>` - Deletes a warp. Permission level of 4 required (op)
- `/renamewarp <name> <newName>` - Renames a warp. Permission level of 4 required (op)
<br><br>
    **With tpa you can teleport to other players or make them teleport to you**
- `/tpa <player>` - Sends a tpa request to another player
- `/tpahere <player>` - Sends a tpaHere request to another player
- `/tpaaccept <player>` -  Accepts the tpa/tpahere request of that player
- `/tpadeny <player>` - Denies the tpa/tpaHere request of that player

<br>

## TODO:
### Planned commands:
- [ ] `/wild` - Teleports you to a random location in the Overworld
- [x] `/worldspawn` - Teleports you to the worldspawn
- [ ] `/spawn <dimension>` - Teleports you to your spawn point in a dimension, defaults to your current dimension
- [ ] `/previous` - Go to the last teleported location

### Improvements:
- [ ] Look into changing the mod into the more safe and sane kotlin (I love java)
- [ ] Add game tests
- [ ] Find the easiest way to backport the mod to older version (help)
- [ ] Create a config to add any delays and disable commands, with commands for operators in game
- [ ] Add a perm system
- [ ] Optimize the translation strings (They are getting out of hand)
- [ ] Potentially setup a better translation system (Maybe I will self-host texterify)
- [x] Find a way to combine the mod loader specific jars into one
- [x] Json Storage automatic updater & cleaner
- [x] Modify /back to check if the location is safe and automatically choose a nearby location that is safe
- [x] Limit tpa requests for a player
- [x] Add translation system
- [x] Improve responses for commands
- [x] Add Quilt support and NeoForge


## Want to help?
1. You can create a translation file so other people can use the mod in their native language: [translations.md](./common/src/main/resources/assets/teleport_commands/lang/translations.md)


## How to build
### Getting the correct environment
#### Nixos
If you are on nixos you can simply go into the folder of where you cloned the repo, and run `nix develop .`. This will give you the environment I use (apart from the IDE) :3.

#### Generic linux
On any other linux distro, just install the jetbrains jdk, or try openjdk21.

#### Windows
On windows probably go to the openjdk website and install the 21 version? Idk goodluck.

### Building
Then on linux just run `./gradlew build`. To make it into a single mod jar just run `./gradlew mergeJars`.

Or on windows, just do `.\gradlew.bat build` and `.\gradlew.bat mergeJars`.
Note that this isn't tested for windows, but I think that is how it works.

### Getting the jars
Then you can find your jars in `fabric/build/libs/` (for fabric), `neoforge/build/libs/` (for neoforge) or `merged/build/libs/` (if you made the merged jar file).

If you have any issues just make an issue or contact me on Discord `@mrsnowy_`

## Random notes lol
Text Colors: 
- Green = When something succeeds and an action will happen
- Aqua = When something needs attention
- White = When something is done
- Red = When something fails