zii/MRCI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

moved the README file back to the root directory and fixed a few grammar

Browse Source 
mistakes.
This commit is contained in:
Maurice ONeal 2022-07-10 22:01:14 -04:00
parent e79efb9482
commit fabc82a0a2
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/README.md → README.md
View File

@ -1,6 +1,6 @@
# MRCI #
(Modular Remote Command Interpreter) is a command interpreter primarily designed to provide any type of remote service to connected clients. As the name implies, it is expandable via 3rd party modules by adding addtional commands that remote clients can run on the host. It has a fully feasured user account management system with access control to certain commands for certain users.
(Modular Remote Command Interpreter) is a command interpreter primarily designed to provide any type of remote service to connected clients. As the name implies, it is expandable via 3rd party modules by adding additional commands that remote clients can run on the host. It has a fully featured user account management system with access control to certain commands for certain users.
### Usage ###
@ -47,25 +47,25 @@ elevate - this argument takes a single string representing a user name to an a
example: -elevate somebody
run_cmd - this argument is used by the host itself, along side the internal module arguments below to run
the internal command names passed by it. this is not ment to be run directly by human input.
the internal command names passed by it. this is not meant to be run directly by human input.
the executable will auto close if it fails to connect to the pipe and/or shared memory segments
```
The host can be managed via a connected client that supports text input/output so the host application is always listening for clients while running entirely in the background. By default the host listen for clients on address 0.0.0.0 and port 35516, effectively making it reachable on any network interface of the host platform via that specific port.
### More Than Just a Command Interpreter ###
Typical use for a MRCI host is to run commands on a remote host that clients ask it to run, very similar to what you see in remote terminal emulators. It however does have a few feasures typically not seen in terminals:
Typical use for a MRCI host is to run commands on a remote host that clients ask it to run, very similar to what you see in remote terminal emulators. It however does have a few features typically not seen in terminals:
* Broadcast any type of data to all peers connected to the host.
* Run remote commands on connected peers.
* Host object positioning data for peers (online games do this).
* Send data to/from a peer client directly.
* Fully feasured user account management system.
* Fully featured user account management system.
* Built in permissions and command access management.
* Host limits management (max concurrent users, max failed password attempts, etc...).
* Account recovery emailing in case of forgotten passwords. **
* Acesss to various logs.
* Access to various logs.
* Built in host file management (copy, move, delete, etc...).
* Built in file upload/download support.
@ -75,13 +75,13 @@ Because the host is modular, the things you can customize it to do is almost lim
### Documentation ###
* [1.1 The Protocol](protocol.md)
* [2.1 Modules](modules.md)
* [3.1 Type IDs](type_ids.md)
* [4.1 Host Features](host_features.md)
* [5.1 Async Commands](async.md)
* [6.1 Shared Memory](shared_data.md)
* [7.1 Internal Commands](intern_commands.md)
* [1.1 The Protocol](docs/protocol.md)
* [2.1 Modules](docs/modules.md)
* [3.1 Type IDs](docs/type_ids.md)
* [4.1 Host Features](docs/host_features.md)
* [5.1 Async Commands](docs/async.md)
* [6.1 Shared Memory](docs/shared_data.md)
* [7.1 Internal Commands](docs/intern_commands.md)
### Build Setup ###
@ -109,7 +109,7 @@ while running the install script, it will ask you to input 1 of 3 options:
***local machine*** - This option will install the built application onto the local machine without creating an installer.
***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 insalled. Only Python3 needs to be installed and an internet connection is not required.
***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 installed. Only Python3 needs to be installed and an internet connection is not required.
***exit*** - Cancel the installation.
@ -123,4 +123,4 @@ sudo systemctl start mrci
sudo systemctl stop mrci
```
In a Windows system, a scheduled task will be created to auto start the application in the background when the system starts.
In a Windows system, a scheduled task will be created to auto start the application in the background when the system starts.