https://github.com/minidomo/osu-thumbnail-generator
Generate YouTube thumbnails for an osu! tournament.
https://github.com/minidomo/osu-thumbnail-generator
Last synced: about 2 months ago
JSON representation
Generate YouTube thumbnails for an osu! tournament.
- Host: GitHub
- URL: https://github.com/minidomo/osu-thumbnail-generator
- Owner: minidomo
- License: unlicense
- Created: 2021-07-04T22:14:24.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T19:59:37.000Z (over 1 year ago)
- Last Synced: 2025-01-19T10:14:59.399Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# osu! Thumbnail Generator
## Prerequisites
- [Node.js](https://nodejs.org/)
- HTML/CSS/JavaScript
## Getting Started
Clone the repository by typing the following into the command line.
```bash
git clone https://github.com/minidomo/osu-thumbnail-generator.git
```
Install the necessary dependencies by typing the following into the command line.
```bash
npm install
```
This program requires a file, `config.json`, in the current directory. An example of its structure and contents can be seen in the `config.json.example` file.
For clarification, a player's user ID can be obtained through the URL of their profile as the URL follows the format, `https://osu.ppy.sh/users/`. In addition, a beatmap's URL follows the format, `https://osu.ppy.sh/beatmapsets/#osu/`.
## Running
Before running the program, the map provided in `config.json` must be downloaded onto your local computer in order to obtain the background of the beatmap.
This program requires a local web server to be run on. Use the provided script to launch the web server.
```bash
npm run server
```
Once the web server is launched, you can view the current state of the thumbnail at http://localhost:8080/. To run the remainder of the program, use the provided script.
```bash
npm run start
```
The resulting screenshot of the thumbnail will be located in the `./out/` folder.
A full list of the provided scripts can be seen below.
| Name | Description |
|:-:|---|
| `clean` | Removes all files in the `./out/` folder. |
| `copy` | Copies the files needed from `./out/` to `./public/`. |
| `generate:raw` | Generates the images and data file used for the thumbnail and outputs to the `./out/` folder. |
| `generate:ss` | Generates a screenshot of the current state of the thumbnail. |
| `start` | Runs the following scripts in this order: `clean`, `generate:raw`, `copy`, `generate:ss`. |