Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
eXhumer authored Apr 19, 2020
1 parent 0570cda commit 54706b7
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TinGen
Script that will allow you to easily generate an index file (with encryption if needed) for use with Tinfoil.
This project is a based on [this project](https://github.com/BigBrainAFK/tinfoil_gdrive_generator/) by [BigBrainAFK](https://github.com/BigBrainAFK/). This script uses the crypto section for encrypting the resulting file from the previously mentioned project.
This project is a based on [this project](https://github.com/BigBrainAFK/tinfoil_gdrive_generator/) by [BigBrainAFK](https://github.com/BigBrainAFK/).
**NOTE: The token generated by this script can also be used with tinfoil.**

## Requirements
Expand All @@ -10,21 +10,20 @@ This project is a based on [this project](https://github.com/BigBrainAFK/tinfoil
- `credentials.json` (or any file name if using `--credentials` flag to pass custom location for the required credential file). 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.

Execute the following command in a terminal to install all the required modules.
Execute the following command in a terminal to install all the required modules.
`pip3 install -r requirements.txt`

## Usage
```
usage: TinGen.py [-h] [--credentials CREDENTIALS_FILE_NAME] [--token TOKEN_FILE_PATH]
[--headless] [--index-file INDEX_FILE_PATH] [--update-mode] [--share-files]
[--no-recursion] [--add-nsw-files-without-title-id] [--add-non-nsw-files]
[--success SUCCESS_MESSAGE] [--encrypt [ENC_INDEX_FILE_PATH]]
[--public-key PUBLIC_KEY_FILE_PATH] [--upload-to-folder-id UPLOAD_FOLDER_ID]
[--upload-to-my-drive] [--new-upload-id] [--share-uploaded-index]
usage: TinGen.py [-h] [--credentials CREDENTIALS_FILE_NAME] [--token TOKEN_FILE_PATH] [--headless]
[--index-file INDEX_FILE_PATH] [--update-mode] [--share-files] [--no-recursion]
[--add-nsw-files-without-title-id] [--add-non-nsw-files] [--success SUCCESS_MESSAGE]
[--encrypt [ENC_INDEX_FILE_PATH]] [--public-key PUBLIC_KEY_FILE_PATH] [--vm-file VM_FILE]
[--drm-key DRM_KEY] [--upload-to-folder-id UPLOAD_FOLDER_ID] [--upload-to-my-drive] [--new-upload-id]
[--share-uploaded-index]
[FOLDER_ID_TO_SCAN [FOLDER_ID_TO_SCAN ...]]
Script that will allow you to generate an index file with Google Drive file links for use with
Tinfoil
Script that will allow you to generate an index file with Google Drive file links for use with Tinfoil
positional arguments:
FOLDER_ID_TO_SCAN Folder IDs of Google Drive folders to scan
Expand All @@ -38,28 +37,28 @@ optional arguments:
--headless Allows to perform Google Token Authentication in headless environment
--index-file INDEX_FILE_PATH
File path for index file
--update-mode Updates existing index file keeping old files, if it exists, instead of
regenerating a new file
--update-mode Updates existing index file keeping old files, if it exists, instead of regenerating a new
file
--share-files Share files all files inside the index file
--no-recursion Scans for files only in top directory for each folder ID entered
--add-nsw-files-without-title-id
Adds files without title ID
--add-non-nsw-files Adds files without valid NSW ROM extension(NSP/NSZ/XCI/XCZ) to index
--success SUCCESS_MESSAGE
Adds a success message to index file to show if index is successfully
read by tinfoil
Adds a success message to index file to show if index is successfully read by tinfoil
--encrypt [ENC_INDEX_FILE_PATH]
Encrypts the resulting index file
--public-key PUBLIC_KEY_FILE_PATH
File Path for Public Key to encrypt with
--vm-file VM_FILE File Path for VM File
--drm-key DRM_KEY DRM Key
--upload-to-folder-id UPLOAD_FOLDER_ID
Upload resulting index to folder id supplied
--upload-to-my-drive Upload resulting index to My Drive
--new-upload-id Uploads the newly generated index file with a new file ID instead of
replacing old one
--new-upload-id Uploads the newly generated index file with a new file ID instead of replacing old one
--share-uploaded-index
Shares the index file that is uploaded to Google Drive
```

## Credits
[BigBrainAFK](https://github.com/BigBrainAFK/) for Crypto Stuff.
[BigBrainAFK](https://github.com/BigBrainAFK/) for Inital Crypto Script for Index Encryption.

0 comments on commit 54706b7

Please sign in to comment.