Difference between revisions of "TrainCarts"
Bergerkiller (talk | contribs) (Add link to api subpage) |
Bergerkiller (talk | contribs) (Marked this version for translation) |
||
(26 intermediate revisions by the same user not shown) | |||
Line 15: | Line 15: | ||
<!--T:4--> | <!--T:4--> | ||
The first thing you will notice is that you can now connect carts together to form infinitely long trains. Every cart in this train is called a ''member'', all members combined are called a ''group''. Every member communicates with the group, so when the front cart hits a block, it stops the entire group. When someone pushes a cart, this pushing force is shared among all members. Therefore, long trains are less responsive than short trains. | The first thing you will notice is that you can now connect carts together to form infinitely long trains. Every cart in this train is called a ''member'', all members combined are called a ''group''. Every member communicates with the group, so when the front cart hits a block, it stops the entire group. When someone pushes a cart, this pushing force is shared among all members. Therefore, long trains are less responsive than short trains. | ||
+ | |||
+ | <!--T:47--> | ||
+ | By default all minecarts placed by players become TrainCarts managed Minecarts. If you want to spawn Vanilla Minecarts that behave with original Minecraft Physics, you can do so through '''permissions''' or by spawning with a '''dispenser'''. [[TrainCarts/VanillaMinecarts|See this page for more information]]. | ||
+ | |||
+ | <!--T:48--> | ||
+ | Mobs no longer get into Traincarts Minecarts by default. If you want to change this, [[TrainCarts/MobEntering|see this page for more information]] or spawn vanilla minecarts instead. | ||
+ | |||
+ | == Spawning == <!--T:50--> | ||
+ | Trains can be spawned by players using Minecart items or the [[TrainCarts/Train Spawn Chest|Train Spawn chest]]. They can be spawned automatically using the [[TrainCarts/Signs/Spawner|spawn sign]]. | ||
+ | |||
+ | <!--T:51--> | ||
+ | [[Special:MyLanguage/TrainCarts/Spawning|» Spawning]] | ||
+ | |||
+ | <!--T:52--> | ||
+ | [[Special:MyLanguage/TrainCarts/Train Spawn Chest|» Train Spawn Chest]] | ||
+ | |||
+ | == Properties == <!--T:44--> | ||
+ | Trains and individual carts of trains have properties. These can be set using commands (/train and /cart) or using the [[TrainCarts/Signs/Property|property sign]]. | ||
+ | |||
+ | <!--T:53--> | ||
+ | [[Special:MyLanguage/TrainCarts/Signs/Property|» Property Sign]] | ||
== New physics == <!--T:5--> | == New physics == <!--T:5--> | ||
Line 40: | Line 61: | ||
[[Special:MyLanguage/TrainCarts/Commands|» Commands]] | [[Special:MyLanguage/TrainCarts/Commands|» Commands]] | ||
− | == | + | == Command Selectors == <!--T:45--> |
− | + | You can use command selectors like ''@train'' and ''@ptrain'' in all other commands (including non-traincarts commands) to perform actions on trains or player passengers of trains based on selector criteria. For tighter integration with other plugins like economies and status effects, this is the ideal mechanism. | |
− | |||
− | |||
− | <!--T: | + | <!--T:46--> |
− | [[ | + | [[TrainCarts/Commands/Selectors|» Command Selectors]] |
== Path finding == <!--T:17--> | == Path finding == <!--T:17--> | ||
Line 55: | Line 74: | ||
<!--T:19--> | <!--T:19--> | ||
[[Special:MyLanguage/TrainCarts/PathFinding|» Traincarts Path Finding]] | [[Special:MyLanguage/TrainCarts/PathFinding|» Traincarts Path Finding]] | ||
+ | |||
+ | == Tickets == <!--T:41--> | ||
+ | |||
+ | <!--T:42--> | ||
+ | Train ticket items can be used to restrict who can enter trains. They can also be used to assign properties to trains when used, such as assigning a destination to go to. | ||
+ | |||
+ | <!--T:43--> | ||
+ | [[Special:MyLanguage/TrainCarts/Tickets|» Traincarts Tickets]] | ||
== Configuration == <!--T:20--> | == Configuration == <!--T:20--> | ||
Line 65: | Line 92: | ||
==Attachments== <!--T:23--> | ==Attachments== <!--T:23--> | ||
+ | |||
+ | <!--T:49--> | ||
+ | The attachment editor is used to configure the appearance of your train. The interactive menu enables players to configure customized trains using item models, entities, seats, sounds and more. All of these can be animated to bring the train alive. | ||
<!--T:24--> | <!--T:24--> | ||
− | [[Special:MyLanguage/TrainCarts/Attachments|» Attachments]] | + | [[Special:MyLanguage/TrainCarts/Attachments|» Attachments]] |
== Permissions == <!--T:25--> | == Permissions == <!--T:25--> | ||
Line 76: | Line 106: | ||
<!--T:27--> | <!--T:27--> | ||
[[Special:MyLanguage/TrainCarts/Permissions|» Overview of all permissions]] | [[Special:MyLanguage/TrainCarts/Permissions|» Overview of all permissions]] | ||
+ | |||
+ | == Performance == <!--T:39--> | ||
+ | Some features by this plugin may result in server or client lag. There are ways to prevent them. | ||
+ | |||
+ | <!--T:40--> | ||
+ | [[TrainCarts/Lag|» Lag]] | ||
== API and Add-ons == <!--T:28--> | == API and Add-ons == <!--T:28--> | ||
Line 82: | Line 118: | ||
TrainCarts has a [[TrainCarts/API|flexible API]] which allows other plugins to implement custom track, signs, attachments and more. | TrainCarts has a [[TrainCarts/API|flexible API]] which allows other plugins to implement custom track, signs, attachments and more. | ||
* [[Special:MyLanguage/TC-Coasters|TC-Coasters]]: Adds smooth rollercoaster track to TrainCarts | * [[Special:MyLanguage/TC-Coasters|TC-Coasters]]: Adds smooth rollercoaster track to TrainCarts | ||
+ | * [https://www.spigotmc.org/resources/tc-hangrail.39627/ TC-Hangrail]: Hang below or float above any kind of block as fake track | ||
+ | * [https://www.spigotmc.org/resources/traincartsdestinationselector.73170/ TrainCartsDestinationSelector]: Adds clickable signs so players can select train destinations | ||
+ | * [https://www.spigotmc.org/resources/traincarts-advancedsigns.99881/ Traincarts AdvancedSigns]: Adds additional sign types, particularly useful for rollercoaster rides | ||
+ | * [https://www.spigotmc.org/resources/tcminecartvariants.100658/ TC Minecart Variants]: Unique models for carts showing different types of resources (coal, gold, etc.) | ||
+ | * [https://www.spigotmc.org/resources/tcanimatronics.101995/ TCAnimatronics]: Play [https://www.spigotmc.org/resources/animatronics-animate-armorstands-1-8-1-18-2.36518/ Animatronics] animations with a Traincarts sign | ||
== Useful Links == <!--T:30--> | == Useful Links == <!--T:30--> | ||
Line 87: | Line 128: | ||
<!--T:31--> | <!--T:31--> | ||
*[https://www.spigotmc.org/resources/traincarts.39592/ Spigot Dev Page & Forum] | *[https://www.spigotmc.org/resources/traincarts.39592/ Spigot Dev Page & Forum] | ||
− | *[https://discord.gg/ | + | *[https://discord.gg/wvU2rFgSnw Discord] |
<!--T:32--> | <!--T:32--> |
Latest revision as of 16:09, 21 September 2024
Minecarts redefined | |
Spigot: | TrainCarts |
---|---|
GitHub: | TrainCarts |
TrainCarts is a plugin developed by Bergerkiller and features everything related to Trains of minecarts. It was initially developed to link multiple carts together, creating a moving train. Over time the plugin grew to host many more features, such as action signs, commands, properties, attachments and a broad API other plugins can implement to add their own features.
Trains
The first thing you will notice is that you can now connect carts together to form infinitely long trains. Every cart in this train is called a member, all members combined are called a group. Every member communicates with the group, so when the front cart hits a block, it stops the entire group. When someone pushes a cart, this pushing force is shared among all members. Therefore, long trains are less responsive than short trains.
By default all minecarts placed by players become TrainCarts managed Minecarts. If you want to spawn Vanilla Minecarts that behave with original Minecraft Physics, you can do so through permissions or by spawning with a dispenser. See this page for more information.
Mobs no longer get into Traincarts Minecarts by default. If you want to change this, see this page for more information or spawn vanilla minecarts instead.
Spawning
Trains can be spawned by players using Minecart items or the Train Spawn chest. They can be spawned automatically using the spawn sign.
Properties
Trains and individual carts of trains have properties. These can be set using commands (/train and /cart) or using the property sign.
New physics
Trains can travel on top of pressure plates and alongside ladders, and also upside-down below vanilla rails placed on a ceiling.
Signs
Loads of different signs are available to automate stations, eject trains, put players in trains or update train configuration.
Command
The plugin has lots of commands you can use to alter the behavior of trains and minecarts.
Command Selectors
You can use command selectors like @train and @ptrain in all other commands (including non-traincarts commands) to perform actions on trains or player passengers of trains based on selector criteria. For tighter integration with other plugins like economies and status effects, this is the ideal mechanism.
Path finding
Trains can have a destination set, after which switcher signs will automatically switch the track to lead the train towards it with the shortest route possible. This can be used to automate a large train network, sending trains to different stations fully automatically. It is also possible to configure a list of destinations the train should visit and have the train automatically go from one destination to the next.
Tickets
Train ticket items can be used to restrict who can enter trains. They can also be used to assign properties to trains when used, such as assigning a destination to go to.
Configuration
TrainCarts can be configured in the config.yml file. All setting nodes have a header to help you understand what that particular node adjusts. Other than that, you can set the default train properties (properties applied to new trains) in the DefaultTrainProperties.yml file. The nodes should speak for themselves. Try not to touch the other files, as it can cause corrupted save data, or the plugin getting out of sync. Deleting the files should re-set TrainCarts completely, may one of the files get corrupted. The plugin automatically generates all configuration needed.
Attachments
The attachment editor is used to configure the appearance of your train. The interactive menu enables players to configure customized trains using item models, entities, seats, sounds and more. All of these can be animated to bring the train alive.
Permissions
Like in all plugins that use BKCommonLib as a base, all permissions can be found in PermissionDefaults.yml in the plugin folder. There they are all listed together with a description and permission default, which you can alter as well.
Performance
Some features by this plugin may result in server or client lag. There are ways to prevent them.
API and Add-ons
TrainCarts has a flexible API which allows other plugins to implement custom track, signs, attachments and more.
- TC-Coasters: Adds smooth rollercoaster track to TrainCarts
- TC-Hangrail: Hang below or float above any kind of block as fake track
- TrainCartsDestinationSelector: Adds clickable signs so players can select train destinations
- Traincarts AdvancedSigns: Adds additional sign types, particularly useful for rollercoaster rides
- TC Minecart Variants: Unique models for carts showing different types of resources (coal, gold, etc.)
- TCAnimatronics: Play Animatronics animations with a Traincarts sign
Useful Links
Traincarts Spigot Jenkins GitHub
BKCommonLib Spigot Jenkins GitHub
TC Coasters Spigot Jenkins GitHub
Depreciated Addons
(No longer supported in current versions of Traincarts)
ActionBlocks, added block-based systems to the game. They were dumbed-down versions of the sign systems mentioned above.