Skip to content

Latest commit

 

History

History
105 lines (97 loc) · 4.5 KB

README.md

File metadata and controls

105 lines (97 loc) · 4.5 KB

SC Essentials

Build status

The common and essentials scripts used across our projects providing code reusability and fast prototyping. This is also required by other SC modules.

Table of Contents

Installation

Simply import this package into Unity. You can also set this repository as a submodule and always keep this up to date. Add it in Assets/SweatyChair/Essentials/. Your .gitmodules should have these lines:

[submodule "Assets/SweatyChair/Essentials"]
	path = Assets/SweatyChair/Essentials
	url = https://github.com/sweatyc/Essentials.git

Configuration

All settings are located at menu toolbar > Sweaty Chair > Settings.

Usage

External Plugins

Essentials uses the follow plugins:

Modules Details

Game analytics and tracking.

Virtual currency system, also works with IAP and use anti-cheat.

Database system that reads CSV and converts to accessible class in-game.

Editor only tools, such as build tool and reference finder.

Tools and utilites for common gameplay, such as bullet spawning.

A system that saves players' progress and sync with Game Center and Play Games.

All in-game helpers not categoized elsewhere.

Player info helpers.

Player inputs managers and utilities, such as keyboard and mobild touches.

The common item data classes that can be used in game.

Translation and localization utility.

The master managers that not categorized elsewhere.

The utility that posts and retrieves data from the backend server.

Game settings helpers, such as graphics quality and sound volume.

Common shop functionalities, for items selling with virual currency or real money.

Singleton base classes.

Game state functionalities. Set and fire events of current game state.

Tweens objects using LeanTween.

All commonly used UI scripts and prefabs.

  • Replacing some stock Unity's UI.
  • Button effects and extended functionalities.
  • Common UI effets.
  • A in-game input field box.
  • A loading screen between each game loading.
  • A message box shown in game.
  • All commonly used panels.
  • An extended InputField for passwords.
  • A progress bar shows player's progress, HP, etc.
  • Sub panel tabs that can switch around in a panel.
  • In-game texts such as in-game notices and announcements.
  • Transition between menus, game levels, etc.
  • All UI tools that not categorized elsewhere.

All tools that not categorized elsewhere.

License

SC Essentials is licensed under a MIT License.