-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
379 additions
and
3,309 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,80 @@ | ||
| # speedcontrol-layouts | ||
| A bundle of easy-to-use NodeCG layouts for marathons to use. | ||
|
|
||
| [](https://github.com/nicnacnic/speedcontrol-layouts/releases) | ||
|  | ||
|  | ||
| [](https://twitter.com/nicnacnic11) | ||
| [](https://discord.gg/A34Qpfe) | ||
|
|
||
| ## About | ||
| *This is a bundle for [NodeCG](https://github.com/nodecg/nodecg); if you do not understand what that is, we advise you read their website first for more information.* | ||
|
|
||
| speedcontrol-layouts was the layout pack used during Horror(ible) Games 2021 - Heartbreak, tweaked to make creating layouts easier. | ||
|
|
||
| ### Features | ||
| - 14 easy-to-use and customizable layouts with deteiled documentation | ||
| - Full Tiltify and Oengus support, showing total amount raised and incentives/prizes | ||
| - A sponsor area, for showcasing products and other events | ||
| - Various Photoshop files to easily make your own layouts | ||
|
|
||
| ## Requirements | ||
| - [NodeCG](https://github.com/nodecg/nodecg) | ||
| - [NodeCG Speedcontrol](https://github.com/speedcontrol/nodecg-speedcontrol) (please use the build branch) | ||
|
|
||
| Additionally, although not required, some basic knowledge of Javascript, HTML and CSS will make it easier to customize these layouts to your liking. | ||
|
|
||
| ## Installation | ||
| Navigate to your root NodeCG folder, then run `nodecg install nicnacnic/speedcontrol-layouts`. After the installation is complete, type `nodecg defaultconfig speedcontrol-layouts` to generate the config file. | ||
|
|
||
| Now you're ready to customize! For guidance, the [wiki](https://github.com/nicnacnic/speedcontrol-layouts/wiki) has everything covered! | ||
|
|
||
| ## Usage | ||
| Use this layout pack as you normally would use a NodeCG graphic. Included are many layouts with many configurations, including 4:3 and 16:9 (from 1p to 4p), GB, GBA, DS, 3DS, intermission, interview, and a customizable omnibar. Photoshop files are also included for easy editing, from simply changing the colors to rearranging elements in your layout. They can be found in `<path_to_nodecg>/bundles/speedcontrol-layouts/graphics/img/photoshop`. | ||
|
|
||
| If you end up using speedcontrol-layouts during your marathon/event, it would be greatly appreciated if you included the repository name and author in your end credits. Thank you! | ||
|
|
||
| ## Commission Work | ||
| I'm now offering commission work! For a small fee, I can make custom layouts, modifications to the dashboard, managing NodeCG and more! Prices usually range from $20 to $200. For more information visit [https://www.nicnacnic.com/commission-work](https://www.nicnacnic.com/commission-work) or contact me through Discord. | ||
|
|
||
| ## Other Bundles | ||
| - [obs-control](https://github.com/nicnacnic/obs-control) A simple NodeCG bundle to control an instance of OBS. | ||
| - [speedcontrol-tweetr](https://github.com/nicnacnic/speedcontrol-tweetr) Control Twitter right from your NodeCG dashboard! | ||
| - [nodecg-dacbot](https://github.com/nicnacnic/nodecg-dacbot) A Discord bot to capture and stream voice channel audio to a specified audio device and show VC users. | ||
|
|
||
| ## Contributing | ||
| There is a lot of inefficient code in this bundle. If you can optimize the code, or add new features, submit a pull request! Before you do, please make sure to **test your code**. | ||
|
|
||
| Bugs or glitches should first be checked against the list of [known bugs](https://github.com/nicnacnic/speedcontrol-layouts/wiki), then by creating an issue in the [issue tracker](https://github.com/nicnacnic/speedcontrol-layouts/issues). Suggestions are always welcome! | ||
|
|
||
| If you're having issues or just want to chat, I can be reached on my [Discord](https://discord.gg/A34Qpfe) server. | ||
|
|
||
| ## Special Thanks | ||
| BashPrime, for making the Calithon Spooktacular layouts which this layout pack is based on. | ||
|
|
||
| Floha258, for helping me with my NodeCG issues and getting custom player data to work correctly. | ||
|
|
||
| The Midwest Speedfest crew, for helping out with my NodeCG issues and for overall being such cool people :D | ||
|
|
||
| ## License | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 nicnacnic | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| # speedcontrol-layouts | ||
| A bundle of easy-to-use NodeCG layouts for marathons to use. | ||
|
|
||
| [](https://github.com/nicnacnic/speedcontrol-layouts/releases) | ||
|  | ||
|  | ||
| [](https://twitter.com/nicnacnic11) | ||
| [](https://discord.gg/A34Qpfe) | ||
|
|
||
| ## About | ||
| *This is a bundle for [NodeCG](https://github.com/nodecg/nodecg); if you do not understand what that is, we advise you read their website first for more information.* | ||
|
|
||
| speedcontrol-layouts was the layout pack used during Horror(ible) Games 2021 - Heartbreak, tweaked to make creating layouts easier. | ||
|
|
||
| ### Features | ||
| - 14 easy-to-use and customizable layouts with deteiled documentation | ||
| - Full Tiltify and Oengus support, showing total amount raised and incentives/prizes | ||
| - A sponsor area, for showcasing products and other events | ||
| - Various Photoshop files to easily make your own layouts | ||
|
|
||
| ## Requirements | ||
| - [NodeCG](https://github.com/nodecg/nodecg) | ||
| - [NodeCG Speedcontrol](https://github.com/speedcontrol/nodecg-speedcontrol) (please use the build branch) | ||
|
|
||
| Additionally, although not required, some basic knowledge of Javascript, HTML and CSS will make it easier to customize these layouts to your liking. | ||
|
|
||
| ## Installation | ||
| Navigate to your root NodeCG folder, then run `nodecg install nicnacnic/speedcontrol-layouts`. After the installation is complete, type `nodecg defaultconfig speedcontrol-layouts` to generate the config file. | ||
|
|
||
| Now you're ready to customize! For guidance, the [wiki](https://github.com/nicnacnic/speedcontrol-layouts/wiki) has everything covered! | ||
|
|
||
| ## Usage | ||
| Use this layout pack as you normally would use a NodeCG graphic. Included are many layouts with many configurations, including 4:3 and 16:9 (from 1p to 4p), GB, GBA, DS, 3DS, intermission, interview, and a customizable omnibar. Photoshop files are also included for easy editing, from simply changing the colors to rearranging elements in your layout. They can be found in `<path_to_nodecg>/bundles/speedcontrol-layouts/graphics/img/photoshop`. | ||
|
|
||
| If you end up using speedcontrol-layouts during your marathon/event, it would be greatly appreciated if you included the repository name and author in your end credits. Thank you! | ||
|
|
||
| ## Commission Work | ||
| I'm now offering commission work! For a small fee, I can make custom layouts, modifications to the dashboard, managing NodeCG and more! Prices usually range from $20 to $200. For more information visit [https://www.nicnacnic.com/commission-work](https://www.nicnacnic.com/commission-work) or contact me through Discord. | ||
|
|
||
| ## Other Bundles | ||
| - [obs-control](https://github.com/nicnacnic/obs-control) A simple NodeCG bundle to control an instance of OBS. | ||
| - [speedcontrol-tweetr](https://github.com/nicnacnic/speedcontrol-tweetr) Control Twitter right from your NodeCG dashboard! | ||
| - [nodecg-dacbot](https://github.com/nicnacnic/nodecg-dacbot) A Discord bot to capture and stream voice channel audio to a specified audio device and show VC users. | ||
|
|
||
| ## Contributing | ||
| There is a lot of inefficient code in this bundle. If you can optimize the code, or add new features, submit a pull request! Before you do, please make sure to **test your code**. | ||
|
|
||
| Bugs or glitches should first be checked against the list of [known bugs](https://github.com/nicnacnic/speedcontrol-layouts/wiki), then by creating an issue in the [issue tracker](https://github.com/nicnacnic/speedcontrol-layouts/issues). Suggestions are always welcome! | ||
|
|
||
| If you're having issues or just want to chat, I can be reached on my [Discord](https://discord.gg/A34Qpfe) server. | ||
|
|
||
| ## Special Thanks | ||
| BashPrime, for making the Calithon Spooktacular layouts which this layout pack is based on. | ||
|
|
||
| Floha258, for helping me with my NodeCG issues and getting custom player data to work correctly. | ||
|
|
||
| The Midwest Speedfest crew, for helping out with my NodeCG issues and for overall being such cool people :D | ||
|
|
||
| ## License | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 nicnacnic | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
Oops, something went wrong.