Merge pull request #64 from wheremyfoodat/docker

Author: MokhaLeee

Dockerfile

@@ -0,0 +1,26 @@
+# Build image with docker build --tag fe6 .
+# Create a container with docker run -it fe6
+# Start the container on subsequent runs with docker start
+# Inside the container, you can run ./setup.sh, which clones the repo and builds agbcc + tools for you
+FROM ubuntu:24.04
+SHELL ["/bin/bash", "-c"]
+CMD ["/bin/bash"]
+
+RUN apt update && apt dist-upgrade -y
+
+# Install sudo just so sudo commands don't fail in the container
+RUN apt install -y sudo git make pkg-config
+RUN apt install -y build-essential gcc-arm-none-eabi binutils-arm-none-eabi libpng-dev python3-full python3-pip python-is-python3
+
+# Create python venv, activate it and install packages
+RUN python -m venv /fe6_venv &&            \
+    source /fe6_venv/bin/activate &&       \
+    pip install requests argparse numpy pillow
+
+# Add our venv to path, so that it's automatically used
+ENV VIRTUAL_ENV=/fe6_venv
+ENV PATH="/fe6_venv/bin:$PATH"
+
+# Add a setup.sh to the container that clones the repo and builds agbcc+tools
+RUN echo "git clone https://github.com/FireEmblemUniverse/fireemblem6j && cd fireemblem6j && ./tools/install_agbcc.sh && ./build_tools.sh" >> setup.sh && \
+    chmod 777 setup.sh

README.md

@@ -16,7 +16,7 @@ GBAFE decompilation progress history can be found on [laqieer's FE decomp portal
 - get a copy of the original rom (still required for every build for now), put it in this folder and name it `fe6-base.gba`.
 
 ```bash
-# install dependence
+# install dependencies
 sudo apt update
 sudo apt install -y build-essential gcc-arm-none-eabi binutils-arm-none-eabi libpng-dev
 python -m pip install requests argparse numpy pillow
@@ -29,6 +29,19 @@ make compare
 
 In the future, a native GCC or GCC-like C compiler (such as clang) will be required to build tools, there is just no tool to build yet.
 
+## Building with Docker
+
+If you're on Windows, MacOS, or a Linux distribution without the necessary packages, you can build the project using [Docker](https://www.docker.com/get-started/), which will create a small Virtual Machine (VM) with all the tools you need.
+
+- Download [Docker Desktop](https://docs.docker.com/get-started/get-docker/) and open it.
+- Download our Dockerfile. Open a terminal and navigate to the Dockerfile's location.
+- `docker build --tag fe6_image .` to build our Docker image.
+- `docker run -it --name fe6_container fe6_image` to create a VM and boot into its shell.
+
+The VM will have all dependencies preinstalled, and a `setup.sh` script which you can run to automatically clone the repo and build agbcc+tools. All you have to do is copy your ROM to the repo's root and run `make compare` to build the project. To copy files between the VM and host, use the [`docker cp` command](https://docs.docker.com/reference/cli/docker/container/cp/#examples)
+
+On subsequent runs, you can start the VM again with `docker start -ai fe6_container`. Many IDEs and text editors, such as Visual Studio Code and CLion, have Docker integration and can connect to your VM for easy development.
+
 ## Contributing
 
 Please do. I'm going to be pretty strict on what I accept though, so mind your formatting and naming conventions.