| Name | mcterm JSON |
| Version |
0.9.7
JSON |
| download |
| home_page | https://newgit.inuxnet.org/devel/bettermcrcon |
| Summary | Better Minecraft Server Terminal |
| upload_time | 2024-11-23 11:07:26 |
| maintainer | None |
| docs_url | None |
| author | Jess Williams |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Jess Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
minecraft
mcrcon
rcon
remote
command
mojang
cli
mcterm
terminal
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Better Minecraft Remote Console
This library utilizes SQLLite3 and Prompt Toolkit to improve upon the mccron package.
Several improvements have been made to include history, word completion, and an
extensive database for many Minecraft console commands.
**The database is required in order to run this tool.**
## Cloning the Repository
You must have git installed.
```
git clone https://newgit.inuxnet.org/devel/bettermcrcon.git
```
## Installation
You can install this library locally by issuing the following command. It is recommended
to use a python virtual environment.
### Setting up and activating the Python Virtual Environment
It is recommended to install within a Python Virtual Environment, please review your
specific OS instructions to install VirtualEnv on your system.
From the directory of the repository:
```
python3 -m venv venv
```
Depending on your OS you may need to source different files. These are located in
`venv\scripts` on Windows and `venv/bin` on Unix, Linux and OSX.
Windows Command Line:
```
venv\scripts\activate.bat
```
Windows Powershell:
```
. venv\scripts\activate.ps1
```
Unix, Linux, OSX:
```
. venv/bin/activate
```
To exit the Virtual Environment:
```
deactivate
```
### Installing using the setup.py
All commands should be run from the root directory of the repository.
```
pip install -r requirements.txt
python3 setup.py install
```
### Installing from [PyPi](https://pypi.org)
```
pip install mcterm
```
### Usage
Installation will install `mcterm` inside the bin path and should be accessible.
The database must be created or installed. If the database cannot be found,
`mcterm` will attempt to create by locating or downloading the SQL Dump of the
database. If this fails, the program will not run.
```
Usage: mcterm [--host <value>] [--port <value>] [--password <value>] [--prompt <value>]
--host - The hostname or IP of the Minecraft Server
--port - The port of the Minecraft Server is listening on for Console.
--password - The password for the server.
--prompt - Custom Prompt (Defaults to '<host>:<port> >>> ')
```
#### Non-MC Commands:
```
<host>:<port> >>> ? <command> # Launches a browser tab for online help
<host>:<port> >>> exit # Exits the console
<host>:<port> >>> quit # Exits the console
```
#### Example Usage:
```
$ mcterm
Server Hostname or IP: 192.168.1.3
Server Port: 11111
Enter Password: secretpassword
Database is valid.
192.168.1.3:11111 >>> ? enchant
```
```
$ mcterm --host 192.168.1.3 --port 11111
Enter Password: secretpassword
Database is valid.
192.168.1.3:11111 >>> help advancement
```
```
$ mcterm --host 192.168.1.3 --port 11111 --password 'secretpassword'
Database is valid.
192.168.1.3:11111 >>> give bob iron_block 64
```
```
$ mcterm --host 192.168.1.3 --port 11111 --password 'secretpassword' --prompt 'MyServer >>> '
Database is valid.
MyServer >>> ? advancement
```
Raw data
{
"_id": null,
"home_page": "https://newgit.inuxnet.org/devel/bettermcrcon",
"name": "mcterm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "minecraft, mcrcon, rcon, remote, command, mojang, cli, mcterm, terminal",
"author": "Jess Williams",
"author_email": "Jess Williams <devel@inuxnet.org>",
"download_url": "https://files.pythonhosted.org/packages/aa/03/efac0368f5ea6b44321c1513000fa600b468f5961552be0d982f38281ff2/mcterm-0.9.7.tar.gz",
"platform": null,
"description": "# Better Minecraft Remote Console\n\nThis library utilizes SQLLite3 and Prompt Toolkit to improve upon the mccron package.\nSeveral improvements have been made to include history, word completion, and an \nextensive database for many Minecraft console commands. \n\n**The database is required in order to run this tool.**\n\n## Cloning the Repository\n\nYou must have git installed.\n\n```\ngit clone https://newgit.inuxnet.org/devel/bettermcrcon.git\n```\n\n## Installation\n\nYou can install this library locally by issuing the following command. It is recommended \nto use a python virtual environment. \n\n### Setting up and activating the Python Virtual Environment\n\nIt is recommended to install within a Python Virtual Environment, please review your \nspecific OS instructions to install VirtualEnv on your system.\n\nFrom the directory of the repository:\n\n```\npython3 -m venv venv\n```\n\nDepending on your OS you may need to source different files. These are located in \n`venv\\scripts` on Windows and `venv/bin` on Unix, Linux and OSX.\n\nWindows Command Line:\n```\nvenv\\scripts\\activate.bat\n```\n\nWindows Powershell:\n```\n. venv\\scripts\\activate.ps1\n```\n\nUnix, Linux, OSX:\n```\n. venv/bin/activate\n```\n\nTo exit the Virtual Environment:\n\n```\ndeactivate\n```\n\n### Installing using the setup.py\n\nAll commands should be run from the root directory of the repository.\n```\npip install -r requirements.txt\npython3 setup.py install\n```\n\n### Installing from [PyPi](https://pypi.org)\n\n```\npip install mcterm\n```\n\n### Usage\n\nInstallation will install `mcterm` inside the bin path and should be accessible. \nThe database must be created or installed. If the database cannot be found, \n`mcterm` will attempt to create by locating or downloading the SQL Dump of the \ndatabase. If this fails, the program will not run.\n\n```\nUsage: mcterm [--host <value>] [--port <value>] [--password <value>] [--prompt <value>]\n\n --host - The hostname or IP of the Minecraft Server\n --port - The port of the Minecraft Server is listening on for Console.\n --password - The password for the server.\n --prompt - Custom Prompt (Defaults to '<host>:<port> >>> ')\n```\n\n#### Non-MC Commands:\n\n```\n<host>:<port> >>> ? <command> # Launches a browser tab for online help\n<host>:<port> >>> exit # Exits the console\n<host>:<port> >>> quit # Exits the console\n```\n\n#### Example Usage:\n\n```\n$ mcterm\nServer Hostname or IP: 192.168.1.3\nServer Port: 11111\nEnter Password: secretpassword\nDatabase is valid.\n192.168.1.3:11111 >>> ? enchant\n```\n\n```\n$ mcterm --host 192.168.1.3 --port 11111\nEnter Password: secretpassword\nDatabase is valid.\n192.168.1.3:11111 >>> help advancement\n```\n\n```\n$ mcterm --host 192.168.1.3 --port 11111 --password 'secretpassword'\nDatabase is valid.\n192.168.1.3:11111 >>> give bob iron_block 64\n```\n\n```\n$ mcterm --host 192.168.1.3 --port 11111 --password 'secretpassword' --prompt 'MyServer >>> '\nDatabase is valid.\nMyServer >>> ? advancement\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Jess Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Better Minecraft Server Terminal",
"version": "0.9.7",
"project_urls": {
"Documentation": "https://newgit.inuxnet.org/devel/bettermcrcon",
"Homepage": "https://newgit.inuxnet.org/devel/bettermcrcon",
"Repository": "https://newgit.inuxnet.org/devel/bettermcrcon"
},
"split_keywords": [
"minecraft",
" mcrcon",
" rcon",
" remote",
" command",
" mojang",
" cli",
" mcterm",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca5bf9252e1d0ec87a6abaa90da15b308ffabe030518ead4409f9a9feb1d3e5a",
"md5": "6b70f8abd406a98568339fdb3e8487a4",
"sha256": "b46609e2e8081c916b9197708fb91dcd120505cfc622e2495e7d04ac2cbb4315"
},
"downloads": -1,
"filename": "mcterm-0.9.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b70f8abd406a98568339fdb3e8487a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8086,
"upload_time": "2024-11-23T11:07:24",
"upload_time_iso_8601": "2024-11-23T11:07:24.946335Z",
"url": "https://files.pythonhosted.org/packages/ca/5b/f9252e1d0ec87a6abaa90da15b308ffabe030518ead4409f9a9feb1d3e5a/mcterm-0.9.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa03efac0368f5ea6b44321c1513000fa600b468f5961552be0d982f38281ff2",
"md5": "387f9c19b18fa83b029aff95b3e5eb6c",
"sha256": "5cc42f223421d8f7457a6981db60a6142e59a73142c82f37532d0ba5d1bd6f98"
},
"downloads": -1,
"filename": "mcterm-0.9.7.tar.gz",
"has_sig": false,
"md5_digest": "387f9c19b18fa83b029aff95b3e5eb6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7671,
"upload_time": "2024-11-23T11:07:26",
"upload_time_iso_8601": "2024-11-23T11:07:26.467521Z",
"url": "https://files.pythonhosted.org/packages/aa/03/efac0368f5ea6b44321c1513000fa600b468f5961552be0d982f38281ff2/mcterm-0.9.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 11:07:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcterm"
}
