From da1a952c251a9b9e619effc556e77f9c4bccaf82 Mon Sep 17 00:00:00 2001 From: Hadi Chokr <158838697+silverhadch@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:20:31 +0200 Subject: [PATCH 1/5] Adding Man page. --- docs/man/plastic.1 | 83 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/man/plastic.1 diff --git a/docs/man/plastic.1 b/docs/man/plastic.1 new file mode 100644 index 0000000..cd50929 --- /dev/null +++ b/docs/man/plastic.1 @@ -0,0 +1,83 @@ +NAME + + plastic - NES emulator with both graphical (GUI) and terminal (TUI) interfaces. + +SYNOPSIS + + plastic + plastic_tui [rom-file] [-a] + +DESCRIPTION + + plastic is a NES emulator written in Rust, designed to run NES games through two different interfaces: a graphical (GUI) interface and a terminal-based (TUI) interface. + + The graphical interface (plastic) does not require any arguments and launches the emulator with a simple, user-friendly graphical interface. + + The terminal-based interface (plastic_tui) allows users to run the emulator in the terminal with optional flags. + +OPTIONS + + plastic + Launches the graphical interface of the emulator. This mode does not take any arguments. + + plastic_tui [rom-file] [-a] + Launches the terminal-based interface. The following options are supported: + - rom-file: Specifies the NES ROM file to load. + - -a: Disables audio output while running the emulator in TUI mode. + +INSTALLATION + + The latest version of plastic and plastic_tui can be installed using Cargo: + + cargo install plastic + cargo install plastic_tui + +KEYBOARD CONTROLS + + Key NES Button + ----------- -------------- + J B + K A + U Select + I Start + W Up + S Down + A Left + D Right + CTRL-R Reset + +GAMEPAD CONTROLS (PS4) + + Gamepad Button NES Button + -------------- -------------- + X B + O A + Select Select + Start Start + D-pad Up Up + D-pad Down Down + D-pad Left Left + D-pad Right Right + +EXAMPLES + + Run plastic with the GUI interface: + + plastic + + Run plastic_tui with a specific ROM file: + + plastic_tui path/to/rom.nes + + Run plastic_tui without audio: + + plastic_tui path/to/rom.nes -a + +LICENSE + + This project is licensed under the MIT License. + +CREDITS + + plastic emulator is a project by Amjad Alsharafi. + This man page was written by Hadi Chokr. From 9a1d1413cc0b8649cdf7b2b615554e4bcdfd00c8 Mon Sep 17 00:00:00 2001 From: Hadi Chokr <158838697+silverhadch@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:26:39 +0200 Subject: [PATCH 2/5] Update plastic.1 --- docs/man/plastic.1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/man/plastic.1 b/docs/man/plastic.1 index cd50929..ef3cfa9 100644 --- a/docs/man/plastic.1 +++ b/docs/man/plastic.1 @@ -15,6 +15,9 @@ DESCRIPTION The terminal-based interface (plastic_tui) allows users to run the emulator in the terminal with optional flags. + Saved states are stored in the following path: + ~/.local/share/plastic/saved_states + OPTIONS plastic From 2c74306726fff0474f9f30035e825d6d9e61e7b4 Mon Sep 17 00:00:00 2001 From: Hadi Chokr <158838697+silverhadch@users.noreply.github.com> Date: Fri, 25 Oct 2024 22:07:25 +0200 Subject: [PATCH 3/5] Update plastic.1 --- docs/man/plastic.1 | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/man/plastic.1 b/docs/man/plastic.1 index ef3cfa9..c90530d 100644 --- a/docs/man/plastic.1 +++ b/docs/man/plastic.1 @@ -1,3 +1,5 @@ +PLASTIC(1) General Commands Manual PLASTIC(1) + NAME plastic - NES emulator with both graphical (GUI) and terminal (TUI) interfaces. From b23bbbef0c38349531e36763209221b4dff2a6a9 Mon Sep 17 00:00:00 2001 From: Hadi Chokr <158838697+silverhadch@users.noreply.github.com> Date: Sun, 27 Oct 2024 07:35:26 +0100 Subject: [PATCH 4/5] Update plastic.1 --- docs/man/plastic.1 | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/man/plastic.1 b/docs/man/plastic.1 index c90530d..5a69f0b 100644 --- a/docs/man/plastic.1 +++ b/docs/man/plastic.1 @@ -2,37 +2,37 @@ PLASTIC(1) General Commands Manual PLASTIC(1) NAME - plastic - NES emulator with both graphical (GUI) and terminal (TUI) interfaces. + plastic - NES emulator with graphical (GUI) and terminal (TUI) interfaces. SYNOPSIS - plastic + plastic [rom-file] plastic_tui [rom-file] [-a] DESCRIPTION - plastic is a NES emulator written in Rust, designed to run NES games through two different interfaces: a graphical (GUI) interface and a terminal-based (TUI) interface. + plastic is an NES emulator written in Rust, designed to run NES games with both a graphical (GUI) and a terminal-based (TUI) interface. - The graphical interface (plastic) does not require any arguments and launches the emulator with a simple, user-friendly graphical interface. + The graphical interface (plastic) can be launched without any arguments (though it can be started from the terminal with a ROM file) and provides a user-friendly graphical experience. - The terminal-based interface (plastic_tui) allows users to run the emulator in the terminal with optional flags. + The terminal-based interface (plastic_tui) allows users to run the emulator in the terminal with optional flags for additional control. - Saved states are stored in the following path: + Saved states are stored at the following path: ~/.local/share/plastic/saved_states OPTIONS plastic - Launches the graphical interface of the emulator. This mode does not take any arguments. + Launches the emulator with the graphical interface. This mode does not require arguments but can accept them if needed. plastic_tui [rom-file] [-a] - Launches the terminal-based interface. The following options are supported: + Launches the emulator with the terminal-based interface. The following options are available: - rom-file: Specifies the NES ROM file to load. - - -a: Disables audio output while running the emulator in TUI mode. + - -a: Disables audio output while running in TUI mode. INSTALLATION - The latest version of plastic and plastic_tui can be installed using Cargo: + The latest versions of plastic and plastic_tui can be installed using Cargo: cargo install plastic cargo install plastic_tui @@ -70,6 +70,8 @@ EXAMPLES plastic + plastic path/to/rom.nes + Run plastic_tui with a specific ROM file: plastic_tui path/to/rom.nes From 3b0348511c80b9df52cdb25e249b2d868160891c Mon Sep 17 00:00:00 2001 From: Hadi Chokr <158838697+silverhadch@users.noreply.github.com> Date: Sun, 27 Oct 2024 09:39:48 +0100 Subject: [PATCH 5/5] Update plastic.1 --- docs/man/plastic.1 | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/man/plastic.1 b/docs/man/plastic.1 index 5a69f0b..d24c337 100644 --- a/docs/man/plastic.1 +++ b/docs/man/plastic.1 @@ -22,8 +22,9 @@ DESCRIPTION OPTIONS - plastic - Launches the emulator with the graphical interface. This mode does not require arguments but can accept them if needed. + plastic [rom-file] + Launches the emulator with the graphical interface. While arguments are optional, specifying a ROM file as an argument is recommended for immediate gameplay. + plastic_tui [rom-file] [-a] Launches the emulator with the terminal-based interface. The following options are available: