Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/DevYukine/rustfoil

Google Drive Index Generator for Tinfoil
https://github.com/DevYukine/rustfoil

encryption gdrive google-drive index rust switch tinfoil

Last synced: about 1 month ago
JSON representation

Google Drive Index Generator for Tinfoil

Awesome Lists containing this project

README 

        
# Rustfoil



This CLI allows you to easy generate an index file for use with Tinfoil from either Google .



This project is based on [TinGen](https://github.com/eXhumer/TinGen) by [eXhumer](https://github.com/eXhumer) & [tinfoil_gdrive_generator](https://github.com/BigBrainAFK/tinfoil_gdrive_generator/) by [BigBrainAFK](https://github.com/BigBrainAFK) 



## Why



- Rust allows to bundle the complete application, no dependency installation required!

- I wanted to get back to rust again and this was a good project to take on!



## Modes



Rustfoil currently supports 2 modes:



- Google Drive

- Http



for the Http mode it assumes you already have an Http Server running which serve the files, it does not serve as an own http server.



## Requirements Google Drive



- credentials.json (you can modify location & name with `--credentials` flag) It can be obtained from [here](https://developers.google.com/drive/api/v3/quickstart/python) by clicking the Enable Drive API button in there while being signed in with the user account you want to generate credentials for or from Google's Developer Console.

- Google Drive Folder IDs to scan and index



## Requirements Http



- Http Server which serves the files

- access to the local files to index



## Usage Google Drive



**NOTE:** the first time `rustfoil.exe` is ran, a URL will be displayed. Copy and paste that URL into your web browser and follow the instructions on screen to continue. This process generates a `token.json` file that allows rustfoil to access your drive.



- To use rustfoil to generate an `index.tfl` file corresponding to your Google Drive folder, run the following command:



```

rustfoil.exe gdrive GOOGLE_DRIVE_FOLDER_IDs

```



This will generate an `index.tfl` file in the same directory that `rustfoil.exe` is located.



- For a more comprehensive guide, check out [ii0606226](https://github.com/ii0606226)'s step-by-step guide [here](https://ii0606226.github.io/gdrive-compendium/rustfoil-steps)!



## Flags and Options



Flag | Description

:--- | :---

`--add-non-nsw-files` | Adds files without valid NSW ROM extension(NSP/NSZ/XCI/XCZ) to index

`--add-nsw-files-without-title-id` | Adds files without valid Title ID

`-h`, `--help` | Prints help information

`--headless` | If OAuth should be done headless (this is needed for remote sessions e.g. running rustfoil on a remote server which can't run a webbrowser on it so instead of opening a new tab for you automatically it gives you a link which you need to copy and paste in your local browser then authorize through and then copy back the token you get in the command line)

`--no-recursion` | Scans for files only in top directory for each Folder ID entered

`--share-files` | Share all files inside the index file

`--share-folders` | Share all folders inside the provided folders

`--share-index` | Shares the index file that is uploaded to Google Drive

`--tinfoil-auth` | If Tinfoil authentication files should be generated

`--upload-my-drive` | If the index file should be uploaded to My Drive

`-V`, `--version` | Prints version information

`--compression ` | Which compression should be used for the index file [default: zstd]  [possible values: Off, ZSTD, Zlib]

`--credentials ` | Path to Google Application Credentials [default: credentials.json]

`--google-api-key ` | Adds a google API key to be used with all gdrive:/ requests

`--location-path ` | Path to location.json file

`--min-version ` | Adds a minimum Tinfoil version to load the index

`--one-fichier-keys ...` | Adds 1Fincher API keys to be used with all 1f:/ requests, If multiple keys are provided, Tinfoil keeps trying them until it finds one that works

`-o ` or `--output-path ` | Path to output index file [default: index.tfl]

`--public-key ` | Path to RSA Public Key to encrypt AES-ECB-256 key with

`--referrer ` | Adds a referrer to index file to prevent others from hotlinking

`--success ` | Adds a success message to index file to show if index is successfully read by Tinfoil

`--theme-blacklist ...` | Adds a list of themes to blacklist based on their hash

`--theme-error ` | Adds a custom theme error message to the index

`--theme-whitelist ...` | Adds a list of themes to whitelist based on their hash

`--tinfoil-auth-path ` | Path to Tinfoil authentication files [default: COPY_TO_SD/switch/tinfoil]

`--token ` | Path to Google OAuth2.0 User Token [default: token.json]

`--upload-folder-id ` | If the index file should be uploaded to specific folder



**NOTE:** It is recommend to use OAuth (`--tinfoil-auth-path` and `--tinfoil-auth`) over using the `--share-files` or `--share-folders` flags as this will make your files public accessible and in most usecases this isn't needed or wanted. OAuth will instead make your files accessible via the generated index for tinfoil only which leads to less issues overall.



## (Planned) Features



### Index



- [x] Generate index (full spec support)

- [x] Change index name

- [x] Change output location



### Compression



- [x] Zlib

- [x] Zstd



### Encryption



- [x] Allow to use Tinfoil encryption (DRM Spec)



### Upload 



- [x] Upload index to own gdrive

- [x] Upload index to team drive



### Sharing



- [x] Share files inside index

- [x] Share folders

- [x] Share uploaded index



### Error Handling



- [ ] Retry gdrive exceptions



## Similar Projects

- [eXhumer/pyTinGen](https://github.com/eXhumer/pyTinGen)

- [tinfoil_gdrive_generator](https://github.com/BigBrainAFK/tinfoil_gdrive_generator/)

- [ownfoil](https://github.com/a1ex4/ownfoil)