Dartboard Manager Documentation

version 1.0                                                                        for Unity

Documentation: Online Documentation

Support: vrchewal.com/unity/dartboard-manager

Asset Store: http://u3d.as/17vp

Jump To:

Introduction

The Dartboard Manager for Unity is a complete dart game system that includes many popular dart games. The system is extendible, allowing you to create your own games or even create your own style of dartboard. Each section of the board is independently configurable.

Some of the features include: fully configurable dartboard, a dart model and dart script, full event driven API, 10 popular dart games, full online and pdf documentation, email support and more.

The included demo gives you a foundation to create your own games and see how simple building your own dart game can truly be. The manager includes 10 popular games and a template to create more dart games for the system. The 10 games are: Baseball, Cricket, 301 / 501 / 701 / 901, Golf, HighScore, Round The Clock, Shanghai.

How To

First, look at the demo scene for a working version of the system and the main scripts. The example script in the demo scene has the relevant functions for tapping into the API. The Dartboard Manager is setup so that you can have multiple running in the same scene. You should use the manager by direct reference as much as possible.

Get Started

From Prefab: Drag in the DartboardManager prefab into your hierarchy from the Assets/Dartboard Manager/Prefabs/ folder. This will bring in the structure of games and the dartboard itself.

From Scratch: Create an empty gameobject, rename it “DartboardManager” and attach the DartboardManager script. Drag in the Dartboard prefab as a child object of the DartboardManager. Create a new empty child object of the Manager and rename it Games. Create children objects under Games for each dart game you want to add.

You will now need a script (GameManager?) to handle event notifications from the Dartboard Manager. Check out DartboardDemo.cs for a full example. Register your callback method with the manager. The Runtime Code Flow section below goes into detail on this process.

Next, you will need to setup your darts. We provide a dart prefab with modifiable materials and dart settings. If you have your own dart models, just add the Dart script onto the dart. If you have your own dart flight mechanics, take a look at the Dart script for the relevant function calls for the dartboard interaction and determining hits/misses. Once your Dart is setup, you can remove it from the scene and instantiate the prefab when you want to give control to the player.

Finally, you will need to create a scoreboard so the player knows the status of the game. See the demo for the example scripts and check the API section below for details on each public method available. There are some scoreboard prefabs available for your use to alter as you see fit. Check out the demo for its general usage.

Runtime Code Flow

A summary of the flow of the system is as follows:

1. In your game manager script, register your event callback with the DartboardManager (DartboardDemo.cs line 70) The DartboardManager will call this function when an event is triggered.

70. DartboardManager.Subscribe(DartManagerCallback);

...

83. public void DartManagerCallback(DartGameEvents GameEvent)

2. Start a new dart game (DartboardDemo.cs see Update()) based on player selection from your UI.

158. DartboardManager.StartGame("Cricket", PlayerCount);

3. Activate your darts, give the player control and do the magic of your game throwing mechanics. In the demo, we use a power meter and simple line renderer for aiming. The Dart.cs script uses Unity Rigidbody physics to determine flight. Upon impact, the relevant DartboardSection is Hit or the dart registers a miss with the DartboardManager.
4. The dart game script runs its unique code and triggers events to determine scoring and game specific logic.
5. The DartboardManager calls your function from step 1, passing the relevant event data. (DartboardDemo.cs line 83)
6. Update the UI, retrieving scoring and player data from the manager API.
7. Repeat step 3 through 6 until the game is over.

How To Create New Dart Games

Inherit from the DartGame script when creating new games. It automatically registers with the Manager and handles basic responses from the Manager. It is recommended that you follow the format and style of the existing games to limit the chance of redundancy.

All relevant functions are overridable. As you will see when reviewing the code of the included games, not all functions are needed to run your custom game. Just override the relevant ones and add your game specific logic. The game Highscore is a very basic game and a good place to start reviewing the concepts. The Cricket script is an example of a more advanced functionality and game logic implementation.

The API is event driven, so it is important that when creating new games that you include event triggers. For example, when the player wins the game, trigger the “GameOver” event and set the winning player. See the API section below for more information.

API

The following methods are open via the Dartboard Manager API. All indexes are a zero based number. Player numbers, non index, are 1 for player 1, 2 for player 2, etc. All functions are available, yet some are best used by game scripts only.

Troubleshooting

Oops, something went wrong. You have come to the right place.

Support

You can get your question answered by emailing support@vrchewal.com

Thank you for your purchase of Dartboard Manager!