Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mtimkovich/slippi-renamer

Rename Slippi files with the characters, tags, and stage.
https://github.com/mtimkovich/slippi-renamer

slippi ssbm

Last synced: 2 months ago
JSON representation

Rename Slippi files with the characters, tags, and stage.

Awesome Lists containing this project

README

        

# Slippi Renamer

Rename Slippi (.slp) game files to include characters, tags, colors, and stage.

**Singles:**
```
Game_20190530T222709.slp -> 20190530T222709 - Marth (BRY) vs Fox (Default) - Battlefield.slp
```

**Doubles:**
```
Game_20190521T212659.slp -> 20190521T212659 - Falco (Red) & Marth (Default) vs Fox (DJ) & Fox (SWRV) - Yoshi's Story.slp
```

## Setup

1. Install [Node.js][node].
2. Download [slippi-renamer][download].
3. Navigate to where slippi-renamer is downloaded in the terminal or Node.js console to using `cd`.
4. Run `npm install`.

## Usage

`FOLDER` is the path to a directory with `*.slp` files.

```
node slp_rename.js "FOLDER"
```

```
Usage slp_rename.js [options]

Options:
--version Show version number [boolean]
-n perform a trial run without renaming [boolean]
-r rename in subdirectories too [boolean]
-h Show help [boolean]

You must provide directories to rename.
```

## Changelog

### 1.2.2
- Added `-r` flag to rename folders recursively.

### 1.2.1
- Show netplay name, if applicable.

### 1.2.0
- Handle non-standard teams.
- Better error handling.

### 1.1.1
- Takes directories as arguments instead of files to better work on Windows.

### 1.1.0
- Show character colors for players without tags.
- Don't rename files that we have trouble parsing.
- Better command line parsing
- `-n` flag to run the script without performing any renaming.

## Authors

* Max "DJSwerve" Timkovich
* IvantheTricourne - additional bug fixes and enhancements.

[node]: https://nodejs.org/en/download/
[download]: https://github.com/mtimkovich/slippi-renamer/archive/master.zip