BSGTools

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
= BSG Tools =
 
= BSG Tools =
[[File:http://i.imgur.com/VuN25ne.png|thumb|alt=BSGTools Logo]]
 
 
This is BSGTools (BirdStreet Games Tools for short). A series of systems, components, utilities and libraries (in one convenient package) for [http://www.unity3d.com Unity] to help you get going.
 
This is BSGTools (BirdStreet Games Tools for short). A series of systems, components, utilities and libraries (in one convenient package) for [http://www.unity3d.com Unity] to help you get going.
  

Revision as of 15:43, 23 May 2014

Contents

BSG Tools

This is BSGTools (BirdStreet Games Tools for short). A series of systems, components, utilities and libraries (in one convenient package) for Unity to help you get going.

BitBucket Repository

https://bitbucket.org/michaeln_bsg/bsgtools

This repository will be moving to GitHub very shortly (as of 5/23/2014) for it's extended open source community.


Project Information

Terminology

A common term used in relation to this project is "module". A "module" represents a larger system or tool included with BSGTools that is self sufficient, and accomplishes a larger task compared to the rest of the contents of BSGTools.

Project Goals

BSGTools aims to be a swiss army knife for anyone using Unity:

  • Both beginners and highly advanced users alike should find the components of this project useful.
  • No single entity of the project should be unuseful, boilerplate, reinventing the wheel, or included "just because".
  • When importing BSGTools into your project, it should feel fluid and module based. Any entity that is dependent on anything outside of Unity Basic should be packaged into a .unitypackage file

Project Restrictions

While BSGTools is an open project for anyone to contribute to, there are some restrictions so that the project goals are not compromised:

  • BSGTools is strictly in C#, the intended language for Unity. Clones of the BSGTools repository for Unityscript or Boo translations are completely acceptable, but these will not be incorporated into the repository linked above.
  • Everything item included in the project must have an open source license that allows for distribution, and is permitted for use in a paid-for game or application.
  • If an addition has no benefit for Unity, it will not be included.

Readme

The official readme for the project can be found at the repository linked above. This contains a more detailed explanation on what is included in the project, discussion of licensing, and more.


Project Contents

Notable Modules

  • InputMaster - An overhaul of Unity's Input system (Located in BSGTools/Utilities)
  • ParallaxDisplay - A work-in-progress parallax system that is focused on performance and infinite scrolling (Located in BSGTools/Components/2D)
  • MonoEvent - A coroutine based event system, for those who are used to doing high level scripting for their game events (Located in BSGTools/Utilities)
  • ZeroAll - A small but incredibly useful series of editor shortcuts for resetting object positions, rotations and scale with a hotkey (Located in BSGTools/ZeroAll)
  • InGameDebugWindow - A drop-down in-game color-coded debug window with scroll-lock and clearing functions (Located in BSGTools/Components)

BSGTools Module Tutorials

Due to the nature of this project being comprised of a mixed bag of components, scripts and tools, every effort has gone into making sure that the layout of the project makes sense. What is not included in the project are tutorials regarding the individual 'modules' that the project includes:

  • InputMaster Primer - A beginner's tutorial to using InputMaster. This tutorial goes over the basics of setting up controls and a master, then using that to control and object in game.
  • InputMaster Advanced - Building off of the first tutorial to introduce more advanced functionality, such as serializing and saving control information as XML.
Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox