Jump to content

BCGM Python: Difference between revisions

From Battle Cats Game Modding Wiki
No edit summary
change link
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
BCGM_Python is a basic command line tool made by [[User:Fieryhenry|fieryhenry]] which can be accessed via [https://codeberg.org/fieryhenry/BCGM-Python Codeberg].
[https://codeberg.org/fieryhenry/BCGM-Python BCGM_Python] is a basic command line tool made by [[User:Fieryhenry|fieryhenry]].
 


== Installing ==
== Installing ==


# Make sure you have installed [https://www.python.org/downloads/ Python], you will need version 3.9 or greater.
# Make sure you have installed [https://www.python.org/downloads/ Python], you will need version 3.9 or greater.
# Run the command: <syntaxhighlight lang="shell" line>py -m pip install -U battle-cats-game-modder</syntaxhighlight> in a shell or command prompt
# The following commands vary depending on your operating system:
# Do stuff
 
<tabber>
|-|Windows=
Run the commands inside Command Prompt, PowerShell or other terminal. Do not run the commands inside the Python interpreter itself.
 
<syntaxhighlight lang="shell" line>
py -m pip install -U battle-cats-game-modder
</syntaxhighlight>
|-|Linux=
Depending on your distro, you might not be able to install it using the system pip. Try running:
 
<syntaxhighlight lang="shell" line>
python3 -m pip install -U battle-cats-game-modder
</syntaxhighlight>
 
If that doesn't work, you have to either install it via [https://pipx.pypa.io/latest/installation/ pipx], or create and activate a virtual environment.
 
=== Pipx ===
 
See [https://pipx.pypa.io/latest/installation/ pipx] for installation guide.
 
Then run:
 
<syntaxhighlight lang="shell" line>
pipx install battle-cats-game-modder
</syntaxhighlight>
 
=== Virtual Environment ===
 
If you want to create a virtual environment instead of using pipx, then run the following:
 
<syntaxhighlight lang="shell" line>
python3 -m virtualenv .venv # creates a virtual environment at ${PWD}/.venv
 
source .venv/bin/activate # activate in bash
 
# source .venv/bin/activate.fish # activate in fish
 
python3 -m pip install -U battle-cats-game-modder # install it
</syntaxhighlight>
 
|-|MacOS=
Run the commands inside a terminal.
 
<syntaxhighlight lang="shell" line>
python3 -m pip install -U battle-cats-game-modder
</syntaxhighlight>
</tabber>
 
== Running ==


<tabber>
<tabber>
|-|First Tab Title=
|-|Windows=
First tab content goes here.
Run the commands inside Command Prompt, PowerShell or other terminal. Do not run the commands inside the Python interpreter itself.
|-|Second Tab Title=
 
Second tab content goes here.
<syntaxhighlight lang="shell" line>
|-|Third Tab Title=
py -m BCGM_Python
Third tab content goes here.
</syntaxhighlight>
|-|Linux / MacOS=
<syntaxhighlight lang="shell" line>
python3 -m BCGM_Python
</syntaxhighlight>
</tabber>
</tabber>

Latest revision as of 19:11, 5 September 2025

BCGM_Python is a basic command line tool made by fieryhenry.

Installing

  1. Make sure you have installed Python, you will need version 3.9 or greater.
  2. The following commands vary depending on your operating system:

Run the commands inside Command Prompt, PowerShell or other terminal. Do not run the commands inside the Python interpreter itself.

py -m pip install -U battle-cats-game-modder

Depending on your distro, you might not be able to install it using the system pip. Try running:

python3 -m pip install -U battle-cats-game-modder

If that doesn't work, you have to either install it via pipx, or create and activate a virtual environment.

Pipx

See pipx for installation guide.

Then run:

pipx install battle-cats-game-modder

Virtual Environment

If you want to create a virtual environment instead of using pipx, then run the following:

python3 -m virtualenv .venv # creates a virtual environment at ${PWD}/.venv

source .venv/bin/activate # activate in bash

# source .venv/bin/activate.fish # activate in fish

python3 -m pip install -U battle-cats-game-modder # install it

Run the commands inside a terminal.

python3 -m pip install -U battle-cats-game-modder

Running

Run the commands inside Command Prompt, PowerShell or other terminal. Do not run the commands inside the Python interpreter itself.

py -m BCGM_Python

python3 -m BCGM_Python