EwanLyon/nodecg-csgo-manager

A NodeCG bundle to provide data from CSGO games

NodeCG CSGO Manager

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

NodeCG CSGO Manager

About The Project

A way to connect to the CSGO Game State Integration using NodeCG. This bundle not only includes the CSGO GSI information but also has tools for creating teams and player profiles while also managing tournaments. This uses NodeCG which is a browser based broadcast graphics manager.

This manager is still in its early stages and needs a lot of clean up and more features to properly work in a tournament. However it does currently work for single matches.

If you use this you may see dev messages in the console log as this is pre v1.

Discord server

Built With

• NodeCG
• TypeScript
• React
• Styled Components

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• NodeCG
• CSGO Game State Integration file

Installation

1. Download from releases.
2. Extract to the nodecg bundles folder so that the file structure is nodecg/bundles/nodecg-csgo-manager/...

Building for development

1. Clone the repo into the NodeCG bundles folder

   cd nodecg/bundles
   git clone https://github.com/EwanLyon/nodecg-csgo-manager.git
   cd nodecg-csgo-manager

2. Install NPM packages

   npm install

3. Run build

   npm run build

4. Start NodeCG

   npm run start

   or

   cd ../..
   node .

Usage

Bundles using NodeCG-CSGO-Manager:

• Basic-CSGO-HUD Template!
• Angles-CSGO-HUD
• Clubwho-CSGO-Graphics

Basic documentation

Roadmap

Currently a lot of code cleanup needs to occur. Expect changes to occur rapidly and break bundles using this.

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.

Contact

Ewan Lyon - @Clubwhom

Project Link: https://github.com/ewanlyon/nodecg-csgo-manager