|
| 1 | +# WFT - 1.3.6 |
| 2 | +### Hello, and welcome to **WFT**. |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | +### NOW IN API 4.0 |
| 7 | + |
| 8 | +This is the official recode of my old plugin WFT, witch had some issues. Overall I was not happy with the result, the code was messy, it was all in one file, there was useless and in-efficient code, with a hard api to use, so decided to recode it. |
| 9 | + |
| 10 | +I have added features, because I felt the plugin needed them, and removed features, as some features where not needed. |
| 11 | + |
| 12 | +## Features added |
| 13 | + |
| 14 | +- WFT-OLD Migration |
| 15 | +- Multiple language support |
| 16 | +- Optional display identifier |
| 17 | +- More Tags |
| 18 | +- Per-Player Texts |
| 19 | +- Packet Texts over Entity |
| 20 | +- More efficient and pretty code |
| 21 | + |
| 22 | +Migration: This should have been added on 1.0, but texts from WFT-OLD will now be automaticly migrated to WFT format. |
| 23 | + |
| 24 | +Language support: You can now change the language of the plugin to suit your server. |
| 25 | + |
| 26 | +Display identifier: You can now turn on or off the option to see the texts unique identifier (Much like Texter, but optional). |
| 27 | + |
| 28 | +More tags: Added many more tags for better, they are also player specific. |
| 29 | + |
| 30 | +Per-Player texts: Players will now get a specific text depending on what tag you use. |
| 31 | + |
| 32 | +Packets: The old plugin used entities, putting more load on the server, whereas this plugin uses packets, therefore creating a more lightweight plugin. |
| 33 | + |
| 34 | +Efficient and pretty code: The code in this plugin is WAY more efficient and clean that the old plugin. The code is also spaced out in multiple files. |
| 35 | + |
| 36 | +## Bug Fixes |
| 37 | + |
| 38 | +### https://github.com/WolfDen133/WFT/issues/21 |
| 39 | +**Status**: Fixed |
| 40 | + |
| 41 | +**Version**: >=1.3.5 |
| 42 | + |
| 43 | +**Fixed in**: <=1.3.6 |
| 44 | + |
| 45 | +### https://github.com/WolfDen133/WFT/issues/20 |
| 46 | + **Status**: Fixed |
| 47 | + |
| 48 | + **Version**: >=1.3.4 |
| 49 | + |
| 50 | + **Fixed in**: <=1.3.5 |
| 51 | + |
| 52 | +### https://github.com/WolfDen133/WFT/issues/12 |
| 53 | + **Status**: Fixed |
| 54 | + |
| 55 | + **Version**: >=1.3.1 |
| 56 | + |
| 57 | + **Fixed in**: <=1.3.2 |
| 58 | + |
| 59 | +### https://github.com/WolfDen133/WFT/issues/16 |
| 60 | + **Status**: Fixed |
| 61 | + |
| 62 | + **Version**: >=1.3.2 |
| 63 | + |
| 64 | + **Fixed In**: <=1.3.3 |
| 65 | + |
| 66 | +## Features |
| 67 | + |
| 68 | +- Refresh timer |
| 69 | +- Tags for various things |
| 70 | +- Lots of useful commands |
| 71 | +- Form or command line options |
| 72 | +- Help subcommand for new people |
| 73 | +- Powerful fast and efficient code |
| 74 | +- Extensive customizable |
| 75 | + |
| 76 | +## Example |
| 77 | + |
| 78 | + |
| 79 | +## Commands |
| 80 | + |
| 81 | +Master command is ft|wft.master |
| 82 | + |
| 83 | +| Subcommand | Permission | Description | Aliases | |
| 84 | +|------------|-------------------|----------------------------------|--------------------------------------------------------| |
| 85 | +| `wft` | `wft.command.use` | The master command | `ft` | |
| 86 | +| `add` | ~ | Add a new ft | `spawn`, `summon`, `new`, `make`, `create`, `c`, `a` | |
| 87 | +| `remove` | ~ | Remove a existing ft | `break`, `delete`, `bye`, `d`, `r`, | |
| 88 | +| `edit` | ~ | Edit an existing ft | `e`, `change` | |
| 89 | +| `tp` | ~ | Teleport to an ft | `teleportto`, `tpto`, `goto`, `teleport` | |
| 90 | +| `tphere` | ~ | Teleport a ft to you | `teleporthere`, `movehere`, `bringhere`, `tph`, `move` | |
| 91 | +| `list` | ~ | See a list of the current fts | `see`, `all` | |
| 92 | +| `help` | ~ | So you can get some in-game help | `stuck`, `h`, `?` | |
| 93 | + |
| 94 | +## Tags |
| 95 | + |
| 96 | +| Tag | Description | |
| 97 | +|--------------------|------------------------------------------------------------| |
| 98 | +| `#` | New line | |
| 99 | +| `&` | Use for color codes (same as `§`) | |
| 100 | +| `{NAME}` | Players real name | |
| 101 | +| `{REAL_NAME}` | Players real name | |
| 102 | +| `{DISPLAY_NAME}` | Players display name (often nick plugins use display name) | |
| 103 | +| `{PING}` | Players Current Ping | |
| 104 | +| `{MAX_PLAYERS}` | Maximum players that can be on the server | |
| 105 | +| `{ONLINE_PLAYERS}` | Currently online player count | |
| 106 | +| `{X}` | Players X Position | |
| 107 | +| `{Y}` | Players Y Position | |
| 108 | +| `{Z}` | Players Z Position | |
| 109 | +| `{REAL_TPS}` | Current server tps | |
| 110 | +| `{TPS}` | Average server tps | |
| 111 | +| `{REAL_LOAD}` | Current server load | |
| 112 | +| `{LOAD}` | Average server load | |
| 113 | +| `{LEVEL_NAME}` | Players current level name | |
| 114 | +| `{LEVEL_FOLDER}` | Players current level folder name | |
| 115 | +| `{LEVEL_PLAYERS}` | Players current level player count | |
| 116 | +| `{CONNECTION_IP}` | The IP address that the player connected from | |
| 117 | +| `{SERVER_IP}` | The servers IP address | |
| 118 | +| `{TIME}` | Current server time (Customisable in config) | |
| 119 | +| `{DATE}` | Current server date (Customisable in config) | |
| 120 | + |
| 121 | +### Create your own |
| 122 | + See how to create your own [here](https://github.com/WolfDen133/WFT-Tags-Example) |
| 123 | + |
| 124 | +## Languages |
| 125 | +- Czech (cz) |
| 126 | +- English (en) |
| 127 | +- German (de) |
| 128 | +- Russian (ru) |
| 129 | +- Slovak (sk) |
| 130 | +- Spanish (sp) |
| 131 | +- Ukrainian (ua) |
| 132 | +- Turkish (tr) |
| 133 | +- Indonesian (id) |
| 134 | + |
| 135 | +But feel free to add your own! |
| 136 | + |
| 137 | +## API |
| 138 | + |
| 139 | +Example: |
| 140 | + |
| 141 | +Import the classes |
| 142 | +```php |
| 143 | + |
| 144 | +use WolfDen133\WFT\WFT; |
| 145 | +use WolfDen133\WFT\Texts\FloatingText; |
| 146 | + |
| 147 | +``` |
| 148 | +Creating the text |
| 149 | +```php |
| 150 | +// Creation and registration |
| 151 | +$floatingText = new FloatingText(new Position($x, $y, $z, $level), $name, $text); |
| 152 | +WFT::getAPI()->registerText($floatingText); |
| 153 | + |
| 154 | +// Spawning |
| 155 | +WFT::getAPI()::spawnTo($player, $floatingText); |
| 156 | +// or |
| 157 | +WFT::getAPI()::spawnToAll($floatingText); |
| 158 | +``` |
| 159 | + |
| 160 | +Changing the ft's text |
| 161 | +```php |
| 162 | +// Changing the text |
| 163 | +$floatingText->setText($text); |
| 164 | + |
| 165 | +// Pushing the update |
| 166 | +WFT::getAPI()::respawnTo($player, $floatingText); |
| 167 | +// or |
| 168 | +WFT::getAPI()::respawnToAll($floatingText); |
| 169 | +``` |
| 170 | + |
| 171 | +That's it, the rest is handled by the plugin |
| 172 | + |
| 173 | +## Credit |
| 174 | + |
| 175 | +- [**WolfDen133**](https://github.com/WolfDen133) (*Main Programmer*) [ฬ๏ɭŦ๔єภ133;#6969] |
| 176 | +- [**McMelonTV**](https://github.com/McMelonTV) (*Translations - Slovak, Czech*) [McMelon#9999] |
| 177 | +- [**TheFixDev**](https://github.com/TheFixDev) (*Translation - German*) [𝓗𝓪𝓫𝓓𝓲𝓬𝓱𝓢𝓸𝓖𝓮𝓻𝓷#6158] |
| 178 | +- [**kostamax27**](https://github.com/kostamax27) (*Suggestion & Translation - Russian, Ukrainian*) [kostamax27#0160] |
| 179 | +- [**Sergittos**](https://github.com/Sergittos) (*Translation - Spanish*) [Sergittos#0001] |
| 180 | +- [**DragonfireHD**](https://github.com/DragonfireHD) (*Translation - Turkish*) |
| 181 | +- [**keenanyafiqy**](https://github.com/keenanyafiqy) (*Translation - Indonesian*) |
| 182 | + |
0 commit comments