Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ewanlyon/nodecg-csgo-manager
A NodeCG bundle to provide data from CSGO games
https://github.com/ewanlyon/nodecg-csgo-manager
broadcast-graphics csgo nodecg
Last synced: about 1 month ago
JSON representation
A NodeCG bundle to provide data from CSGO games
- Host: GitHub
- URL: https://github.com/ewanlyon/nodecg-csgo-manager
- Owner: EwanLyon
- License: gpl-3.0
- Created: 2020-12-13T10:43:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-10T22:21:04.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T08:56:02.528Z (9 months ago)
- Topics: broadcast-graphics, csgo, nodecg
- Language: TypeScript
- Homepage:
- Size: 6.11 MB
- Stars: 13
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NodeCG CSGO Manager
Table of Contents
# 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](https://discord.gg/TuQMDdPAdQ)
### Built With
* [NodeCG](https://www.nodecg.dev/)
* [TypeScript](https://www.typescriptlang.org/)
* [React](https://reactjs.org/)
* [Styled Components](https://styled-components.com/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* [NodeCG](https://www.nodecg.dev/docs/installing)
* CSGO Game State Integration file
### Installation
1. Download from [releases](https://github.com/EwanLyon/nodecg-csgo-manager/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
```sh
cd nodecg/bundles
git clone https://github.com/EwanLyon/nodecg-csgo-manager.git
cd nodecg-csgo-manager
```
2. Install NPM packages
```sh
npm install
```
3. Run build
```sh
npm run build
```
4. Start NodeCG
```sh
npm run start
```
or
```sh
cd ../..
node .
```
## Usage
Bundles using NodeCG-CSGO-Manager:
* [Basic-CSGO-HUD Template!](https://github.com/EwanLyon/basic-csgo-hud)
* [Angles-CSGO-HUD](https://github.com/EwanLyon/angles-csgo-hud)
* [Clubwho-CSGO-Graphics](https://github.com/EwanLyon/clubwho-csgo-graphics)
[Basic documentation](./docs/)
## Roadmap
Currently a lot of code cleanup needs to occur. Expect changes to occur rapidly and break bundles using this.
See the [open issues](https://github.com/EwanLyon/nodecg-csgo-manager/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](https://twitter.com/clubwhom)
Project Link: [https://github.com/ewanlyon/nodecg-csgo-manager](https://github.com/ewanlyon/nodecg-csgo-manager)