# Microcosm
Just a little 4X game written in Python using the library [Pyxel](https://github.com/kitao/pyxel).
Inspiration taken from games I've played.
## Pre-requisites
Playing Microcosm requires an installation of VLC media player on the player's machine. Installation instructions for
your favourite operating system can be found [here](https://www.videolan.org/vlc/). If your operating system lists
python-vlc (or something like that) as an optional dependency, it is advised that players also install that. Naturally,
Python is also required, at version 3.10 or above.
### Multiplayer
In order to play games of Microcosm online, your computer and router must have UPnP enabled, as it is required for
communication between clients and the server.
## Play from release
Begin by downloading the [latest release](https://github.com/ChrisNeedham24/microcosm/releases/latest) for your operating system.
### macOS
1. Extract the downloaded zip; double-clicking it in Finder is the easiest way.
2. An application will be extracted - right click it and select Open.
3. In the displayed security-related dialog, press the Open button again to start the game.
Please note that only ARM64 architectures are supported.
### Linux
In terms of Linux distros, Fedora is explicitly supported and Ubuntu is built for, but the build is not tested. Other distros should find success in one of these two.
Additionally, only x86 architectures are supported.
1. Extract the downloaded tarball using `tar -xzvf`.
2. A binary will be extracted; run `./microcosm` to start the game.
### Windows
1. Extract the downloaded zip.
2. An EXE file will be extracted - run this to start the game, allowing Windows Defender to run any scans if it asks to do so.
## Play from package
1. Run `pip install microcosm-4x`
2. Run `microcosm`
1. Note: if this doesn't work, make sure Python's scripts directory is on your PATH.
See [here](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site) for instructions for Windows
(this is not usually a problems on other operating systems).
## Play from source
1. Clone the repository.
2. Run `pip install -r requirements.txt`
3. Run `pyxel run microcosm`
## Wiki
The Wiki can be viewed both [on GitHub](https://github.com/ChrisNeedham24/microcosm/wiki) and in-game.
Raw data
{
"_id": null,
"home_page": null,
"name": "microcosm-4x",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "4x, game, pyxel",
"author": null,
"author_email": "ChrisNeedham24 <christopherneedham24@gmail.com>",
"download_url": null,
"platform": null,
"description": "# Microcosm\nJust a little 4X game written in Python using the library [Pyxel](https://github.com/kitao/pyxel).\nInspiration taken from games I've played.\n\n\n\n## Pre-requisites\nPlaying Microcosm requires an installation of VLC media player on the player's machine. Installation instructions for\nyour favourite operating system can be found [here](https://www.videolan.org/vlc/). If your operating system lists\npython-vlc (or something like that) as an optional dependency, it is advised that players also install that. Naturally,\nPython is also required, at version 3.10 or above.\n\n### Multiplayer\nIn order to play games of Microcosm online, your computer and router must have UPnP enabled, as it is required for\ncommunication between clients and the server.\n\n## Play from release\n\nBegin by downloading the [latest release](https://github.com/ChrisNeedham24/microcosm/releases/latest) for your operating system.\n\n### macOS\n\n1. Extract the downloaded zip; double-clicking it in Finder is the easiest way.\n2. An application will be extracted - right click it and select Open.\n3. In the displayed security-related dialog, press the Open button again to start the game.\n\nPlease note that only ARM64 architectures are supported.\n\n### Linux\n\nIn terms of Linux distros, Fedora is explicitly supported and Ubuntu is built for, but the build is not tested. Other distros should find success in one of these two.\n\nAdditionally, only x86 architectures are supported.\n\n1. Extract the downloaded tarball using `tar -xzvf`.\n2. A binary will be extracted; run `./microcosm` to start the game.\n\n### Windows\n\n1. Extract the downloaded zip.\n2. An EXE file will be extracted - run this to start the game, allowing Windows Defender to run any scans if it asks to do so.\n\n## Play from package\n\n1. Run `pip install microcosm-4x`\n2. Run `microcosm`\n 1. Note: if this doesn't work, make sure Python's scripts directory is on your PATH.\n See [here](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site) for instructions for Windows\n (this is not usually a problems on other operating systems).\n\n## Play from source\n\n1. Clone the repository.\n2. Run `pip install -r requirements.txt`\n3. Run `pyxel run microcosm`\n\n## Wiki\n\nThe Wiki can be viewed both [on GitHub](https://github.com/ChrisNeedham24/microcosm/wiki) and in-game.\n",
"bugtrack_url": null,
"license": null,
"summary": "A little 4X game written using Pyxel.",
"version": "4.0.1.post19",
"project_urls": {
"Documentation": "https://github.com/ChrisNeedham24/microcosm#readme",
"Issues": "https://github.com/ChrisNeedham24/microcosm/issues",
"Source": "https://github.com/ChrisNeedham24/microcosm"
},
"split_keywords": [
"4x",
" game",
" pyxel"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aefdfa873860f994a0d2812b1d1087b5e26045c05b3cd7d50f6d8ce61fbc843c",
"md5": "707c7f5d997e7fa332b01baa8b78018e",
"sha256": "e27a69a44a97d7e9c6fdbb6c58a19add49bfda5be49d132705bb8359b61bb11a"
},
"downloads": -1,
"filename": "microcosm_4x-4.0.1.post19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "707c7f5d997e7fa332b01baa8b78018e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 45594424,
"upload_time": "2025-01-12T12:12:27",
"upload_time_iso_8601": "2025-01-12T12:12:27.937818Z",
"url": "https://files.pythonhosted.org/packages/ae/fd/fa873860f994a0d2812b1d1087b5e26045c05b3cd7d50f6d8ce61fbc843c/microcosm_4x-4.0.1.post19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 12:12:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ChrisNeedham24",
"github_project": "microcosm#readme",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "pyxel",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "python-vlc",
"specs": [
[
"==",
"3.0.16120"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"3.9.1"
]
]
},
{
"name": "Pillow",
"specs": [
[
"==",
"10.3.0"
]
]
},
{
"name": "miniupnpc",
"specs": [
[
"==",
"2.0.2"
]
]
},
{
"name": "miniupnpc",
"specs": [
[
"==",
"2.2.7"
]
]
}
],
"lcname": "microcosm-4x"
}
JSON
