TeacupsPro icon

TeacupsPro -----

Add programmable teacup attractions to your server!



TeacupsPro
Add programmable teacup attractions to your server!
TeacupsPro is thé teacups plugin for your theme park server. It is extremely customizable, supports models and is entirely free and open-source!

Features:

  • Multi-version support
  • Smooth teacup attractions using packets
  • Fully customize your teacup attraction with teacup files
  • Program shows for your teacups using show files
  • Rotate carts with player input
  • Model support
  • Simple config errors to easily fix config problems
  • PlaceholderAPI support in some cases
Dependencies:
Getting started:
Before I'll tell you how to get started, I must warn you that this plugin can be quite complex. I advise that you have some experience dealing with config files and messing around before using this plugin.

1. Creating a teacup
Create a teacup file, this can be done with /teacup create or by creating a new .yml file with the default contents of a teacup.

Code (YAML):

settings
:
  location
:
    world
: World
    x
: -173.5
    y
: 5
    z
: -60.5
  radius
: 10
  show
:
    auto-start-delay
: 15
    default-show
: defaultshow

cartgroups
:
  #automatically spaces them out evenly
  cartgroup1
:
    radius
: 3.5
    model
:
      type
: brick
      modeldata
: 1
    #automatically spaces them out evenly
    carts
:
      cart1
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'a b cd '
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
            c
:
              type
: JUNGLE_TRAPDOOR
            d
:
              type
: SPRUCE_TRAPDOOR
      cart2
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'abab'
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
  cartgroup2
:
    radius
: 3.5
    model
:
      type
: brick
      modeldata
: 1
    carts
:
      cart1
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'abab'
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
      cart2
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'abab'
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
  cartgroup3
:
    radius
: 3.5
    model
:
      type
: brick
      modeldata
: 1
    carts
:
      cart1
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'abab'
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
      cart2
:
        radius
: 2
        model
:
          type
: brick
          modeldata
: 2
        seats
:
          seatlayout
: 'abab'
          models
:
            a
:
              type
: OAK_TRAPDOOR
            b
:
              type
: BIRCH_TRAPDOOR
 

2. Editing the teacup
Edit the file to your likings. This can be done by for instance editing the main settings like the location of the teacup or by editing the carts or cartgroups. A detailed description of the contents can be found here.

3. Loading the teacup
Restart your server or reload the teacups by using /teacups reload teacups.

4. Using the teacup
The teacup should be ready to go! Use /teacup setrpm to let the components of your teacup rotate. However, you may want to make a show as well. So that your teacup can automatically start and perform certain programmes.

5. (Optional) Making a show
Shows work with files as well. In the show files, you can program what will happen whenever a show is executed for a certain teacup. You will be able to determine which actions will be executed at the start, stop and at a certain tick after the show has started. Click here for a detailed guide on how to make a show file.

Code (Text):
start cmd say start
start lock true
0 console say tick 0
0 rpm teacup 10
10 rpm teacup 20
20 rpm teacup 30

#test comment
#Comments start with a '#' and are not reported as problems.

100 console say tick 100
100 chat &2100!!!
100 actionbar &c100!!
100 player say 100
100 rpm teacup 50

150 rpm teacup 30
175 rpm teacup 15
185 rpm teacup 10
190 rpm teacup 5

200 console say tick 200
200 rpm teacup 0
stop kick
stop cmd say stop
stop lock false

5. (Optional) Starting a show
Shows can be started in two different ways.

The first method is via auto-start. To make this work, you will have to set 'default-show' in the teacup's config to the show's name. Now, if you will execute '/teacup action start your-teacup' for that teacup, it will start the selected default-show. If you also want to start the show whenever a player enters the ride, you will have to set 'auto-start-delay' to a number higher than 0.

The second method is by using '/teacup action start your-teacup false your-show'.


Screenshots and gifs:
Coming soon!

Commands:
A detailed description of all the commands and permissions can be found on GitHub.
  • /teacup help - displays a detailed help message (powered by the cloud framework!)
  • /teacup reload - reload all teacups/shows or a specific one.
  • /teacup spawn - spawn a new teacup attraction
  • /teacup action - start or stop a teacup attraction
  • /teacup setrpm - set the rotates per minute of a teacup or it's components.
  • /teacup lock - locks the teacup, meaning that players won't be able to leave or enter a seat of that teacup.
  • /teacup kick - kicks all players or a specific player from a teacup.
  • /teacup execute - execute a command for every player in a teacup.
Documentation:
There is a wiki on GitHub that should hopefully answer all your questions. If you still have questions, then I will be answering them in the discussion section on Spigot or GitHub.
This plugin can initially be scary because of all the configuration files. But soon after you will realize how few restrictions you have in creating teacups.


Developer API:
Once again this topic is handled on GitHub. The developer API is currently very limited and will be expanded if there is demand.

Bugs or feature requests:
If you are experiencing a bug or want a feature added, then please open an issue on GitHub. From there I will be able to offer support.

Please take the time to rate my plugin, if you are actively using it on your server. That way people can easily see if it is worth a try. And I can make it as good as possible.
Resource Information
Author:
----------
Total Downloads: 190
First Release: Feb 4, 2022
Last Update: Aug 7, 2022
Category: ---------------
All-Time Rating:
1 ratings
Find more info at github.com...
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings