Skip to content

Read ".rkg" files in A Command Line Interface (CLI)

License

Notifications You must be signed in to change notification settings

TheDoubleMix/RKGViewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RKG Viewer CLI

Tests

A Command Line Interface (CLI) tool for reading and displaying the contents of .rkg files in a human-readable format. Perfect for inspecting or analyzing .rkg files with only a terminal.

Features

  • Read .rkg files: Decodes and displays the contents of .rkg files directly in your terminal.
  • Readable Output: Formats the file data for easy interpretation.

Installation

  1. Clone the repository:

    git clone https://github.com/TheDoubleMix/RKGViewer.git
    cd RKGViewer
  2. Install dependencies:

    pip install -r requirements.txt
  3. Make the script executable (optional):

    chmod +x app.py

How to use

Run the tool with an .rkg file as input, or not:

python app.py path/to/your/file.rkg

or

python app.py

If you don't pass a .rkg file as input, you will get a error. More in the Errors/Warnings section.

Example:

python app.py sample.rkg

This will display a list of options to use on the .rkg file.

Output:

> Info
  Inputs
  Misc
  Options
Press ESC to quit/→ to select.

The RKG Viewer CLI is still in beta, If you use the inputs or options menu, you will get a warning. More in the Errors/Warnings section.

Errors/Warnings

The CLI is designed to handle standard .rkg file formats, if you want to use any other option, it's possible. if the you have a corrupted file/a non .rkg file, you get a warning about it.

Example:

01100110011100100110111101101101          First 32 bits
01010010010010110100011101000100           Correct bits

If there are too many arguments the program you will get a warning.

Example:

Too Many arguments!
If you want to you can still select the file you want to choose.

If there are no arguments the program you will also get a warning.

Example:

No RKG File argument given!
Type "exit" to exit rkgview
Give a path to a rkg file:

The RKG Viewer CLI is still in beta, If you use the inputs or options menu, you will get a warning.

Example:

Not Implemented
Press ESC to quit this menu. 

Issues

For issues, please report them in the issues section.

License

This project uses the MIT License.


Thank you for using the RKG Viewer CLI! 🎉

About

Read ".rkg" files in A Command Line Interface (CLI)

Resources

License

Stars

Watchers

Forks

Languages