https://github.com/pushfoo/pyc2e

A pure python interface for managing c2e instances and injecting CAOS
https://github.com/pushfoo/pyc2e

Last synced: 10 months ago
JSON representation

A pure python interface for managing c2e instances and injecting CAOS

• Host: GitHub
• URL: https://github.com/pushfoo/pyc2e
• Owner: pushfoo
• License: bsd-2-clause
• Created: 2020-05-09T12:08:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T03:38:37.000Z (almost 2 years ago)
• Last Synced: 2025-03-27T15:52:45.331Z (11 months ago)
• Language: Python
• Size: 73.2 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
=====

pyc2e

=====

.. |PyTest results| image:: https://github.com/pushfoo/pyc2e/actions/workflows/test.yaml/badge.svg

   :target: https://github.com/pushfoo/Fontknife/actions/workflows/test.yaml

.. |GitHub license| image:: https://img.shields.io/github/license/pushfoo/pyc2e.svg?color=brightgreen

   :target: https://github.com/pushfoo/pyc2e/blob/master/LICENSE

.. |PRs Welcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

   :target: https://makeapullrequest.com

|PyTest results| |GitHub license| |PRs Welcome|

A pure Python interface for injecting `CAOS code `_ & reading output from the

`Creatures Evolution Engine (c2e) `_.

It works by calling relevant parts of the Win32 API through `Python's built-in ctypes module `_, as described in `Chris Double's documentation

of the c2e shared memory interface `_.

----------

Installing

----------

The only requirements are:

* Python 3.7+

* A compatible c2e version running in the same permission space as the Python interpreter

.. list-table::

   :header-rows: 1

   * - Install Method

     - Benefits

     - Steps

   * - With `pip`

     - Easiest

     - #. `Create & activate a virtual environment `_

       #. ``pip install pyc2e``

   * - From source

     - Freshest code

     - #. `Clone this repository `_

       #. ``cd pyc2e``

       #. `Create & activate a virtual environment `_

       #. ``pip install -e .``

-------------------

Usage & Limitations

-------------------

*Warning: Running custom CAOS can break your Creatures 3 / DS install.*

Running & injecting `CAOS `_ on Windows is reasonably complete.

.. list-table::

   :header-rows: 1

   * - CAOS Origin

     - Command Syntax

   * - From files

     - ``pyc2e inject --file filename.cos``

   * - Piping from standard input

     - ``cat filename.cos | pyc2e inject``

   * - Strings passed as arguments*

     - ``pyc2e inject --caos "outs \"testing\""``

*\*On Windows, you might need to omit the escapes around the quotes.*

----------------------

Unimplemented Features

----------------------

Engine, config, and launch management for testing and/or fuzzing may be added later.

Support for the Linux version will likely stay incomplete because the community prefers the Windows version for multiple reasons:

#. The Linux version is difficult to install:

   #. Dwindling support for 32 bit code on maintained amd64 Linux distros

   #. Bit rot is rendering precompiled dependencies unusable

   #. Difficulty finding package downloads of linux packages built in 2000

#. All Windows versions crash much less than the Linux builds

#. Running WINE or a VM does not have prohibitive performance penalty for a game this old

#. There are Windows versions of Docking Station and C3 available from multiple sources:

   .. list-table::

      :header-rows: 1

      * - Source Link

        - Price

        - Creatures 3 Included

        - Win10 Compatibility Patches

      * - `Eemfoo archive `_

        - Free

        - No

        - No

      * - `Steam (Creatures: The Albian Years) `_

        - $5.99 USD

        - Yes

        - Yes

      * - `GOG (Creatures: The Albian Years) `_

        - $5.99 USD

        - Yes

        - Yes