From f04a2ef34e90157142514f3bc111ffe6969a63f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Gia=20Phong?= Date: Fri, 26 Jun 2020 11:29:56 +0700 Subject: [PATCH] Update README --- README.md | 34 ++++++++++++++++++++++++++-------- axuy/__init__.py | 1 - axuy/peer.py | 4 ++-- 3 files changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8706e77..e6860b3 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,35 @@ Mininalist peer-to-peer first-person shooter * P2P communication based on calculated *trust* * Modularized for the ease of bot scripting +## Screenshots + +Since axuy's screenshots would look like some kinky abstract art, +I instead document the development progress as short clips on Youtube, +[listed in reverse chronological order][yt]. If software freedom is concerned, +one may view them using MPV with youtube-dl support. + ## Installation -The game is still work-in-progress. For testing, first install GLFW version 3.3 -(or higher), then install the game in editable mode: +The game is still work-in-progress. Preview releases are available on PyPI +and can be installed for Python 3.6+ via -```sh -$ git clone https://github.com/McSinyx/axuy.git -$ pip3 install --user --editable axuy -$ axuy --port=42069 & -$ axuy --seeder=:42069 -``` + pip install axuy + +Unless one is on either Windows or macOS, perse would have to +additionally install GLFW version 3.3 (or higher). + +Axuy can then be launch from the command-line using + + axuy --port=42069 & + axuy --seeder=:42069 There is also `aisample` in `tools` as an automated example with similar command-line interface. + +For hacking, after having dependenies installed, one may also invoke axuy +from the project's root directory by + + python -m axuy --port=42069 & + python -m axuy --seeder=:42069 + +[yt]: https://www.youtube.com/playlist?list=PLAA9fHINq3sayfxEyZSF2D_rMgDZGyL3N diff --git a/axuy/__init__.py b/axuy/__init__.py index b8e0246..a17af61 100644 --- a/axuy/__init__.py +++ b/axuy/__init__.py @@ -33,4 +33,3 @@ from .pico import * __all__ = (misc.__all__ + pico.__all__ + peer.__all__ + display.__all__ + control.__all__) -__version__ = peer.__version__ diff --git a/axuy/peer.py b/axuy/peer.py index 3df9c96..c907e6e 100644 --- a/axuy/peer.py +++ b/axuy/peer.py @@ -17,8 +17,8 @@ # along with Axuy. If not, see . __doc__ = 'Axuy peer' -__all__ = ['PeerConfig', 'Peer'] -__version__ = '0.0.10' +__all__ = ['__version__', 'PeerConfig', 'Peer'] +__version__ = '0.0.11' from abc import ABC, abstractmethod from argparse import ArgumentParser, FileType, RawTextHelpFormatter