Skip to content

Commit

Permalink
improved explanation #21
Browse files Browse the repository at this point in the history
  • Loading branch information
SegoCode committed Dec 3, 2022
1 parent a43e89a commit 94538d6
Showing 1 changed file with 45 additions and 18 deletions.
63 changes: 45 additions & 18 deletions COMPILING.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,73 @@

# Compiling from source

First off, thanks for your interest in Autowall!💕 Have you already read the [contribution guide](https://github.com/SegoCode/AutoWall/blob/master/CONTRIBUTING.md)?
First off, thanks for your interest in Autowall💕 Have you already read the [contribution guide](https://github.com/SegoCode/AutoWall/blob/master/CONTRIBUTING.md)?


## Software needed

MPV binary (Portable) available [here](https://mpv.io/installation/).
To compile Autowall, you will need to download and install a few tools:
- MPV binary (Portable), available [here](https://mpv.io/installation/).
- Weebp binary (Portable), available [here](https://github.com/Francesco149/weebp/releases).
- Autoit compiler [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm), available [here](https://www.autoitscript.com/cgi-bin/getfile.pl?autoit3/autoit-v3.zip).

Weebp binary (Portable) available [here](https://github.com/Francesco149/weebp/releases).
To compile the optional extra features in the [``AutoWall/src/tools/``](https://github.com/SegoCode/AutoWall/tree/master/src/tools) directory, you will also need to [download and install golang](https://go.dev/doc/install) but are not necessary to run AutoWall.

Autoit compiler [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) available [here](https://www.autoitscript.com/cgi-bin/getfile.pl?autoit3/autoit-v3.zip).

For compile extra features also called ``tools`` in [``AutoWall/src/tools/``](https://github.com/SegoCode/AutoWall/tree/master/src/tools) you have to [download and install golang](https://go.dev/doc/install) but they are not necessary to run autowall.
## Building

To compile Autowall, you will need to download the repository and place the necessary binaries in the correct directories.

## Building
First, download the Autowall repository using git:

First of all download the repository ```git clone https://github.com/SegoCode/AutoWall```.
```bash
git clone https://github.com/SegoCode/AutoWall
```

Now with the [mpv](https://mpv.io/installation/) and [weebp](https://github.com/Francesco149/weebp/releases) binary unzip to respectives folders ```AutoWall/src/weebp``` and ```AutoWall/src/mpv```.
Now, with the [mpv](https://mpv.io/installation/) and [weebp](https://github.com/Francesco149/weebp/releases) binary unzip to respectives folders ```AutoWall/src/weebp``` and ```AutoWall/src/mpv```. Once these files are in place, you can proceed with the compilation process.

## Compiling

Using [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) compile to x64 ``Autowall.au3`` and keep binary in the actual ``.au3`` folder, also you can select the icon avaliable [here](https://github.com/SegoCode/AutoWall/tree/master/media).
To compile Autowall, you will need to use the [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) compiler to build the ``Autowall.au3`` file.

To do this, open [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) and select the ``Autowall.au3`` file. Then, select the x64 option and compile. This will create the ``Autowall.exe`` file, keep binary in the actual ``Autowall.au3`` root folder. You can also choose an icon for the binary avaliable [here](https://github.com/SegoCode/AutoWall/tree/master/media).

After compiling the ``Autowall.au3`` file, you can run Autowall by double-clicking the ``Autowall.exe`` file. This will launch the program and you can begin using it.

__At this point you can use AutoWall running Autowall.exe__ , but some extra functions will not be available, for that remains you will have to compile all ``tools`` files in ``AutoWall/src/tools``.
However, some of the extra features may not be available. To enable these, you will need to compile the files in the [``AutoWall/src/tools/``](https://github.com/SegoCode/AutoWall/tree/master/src/tools) directory. These files are optional and are not necessary for Autowall to function, but they provide additional functionality that some users may find useful.

To compile these files, follow the instructions in the "Compiling extra tools" section of the guide. This will produce additional .exe files that Autowall can use to enable these features. Once these files have been compiled, you will have a fully functional version of Autowall with all of the extra features enabled.

## Compiling extra tools
*Keep in mind, Autowall its only a script to coordinate mpv and weebp, it has no dependence with ``AutoWall/src/tools`` , and all the extra files the only thing that do Autowall is running a binary called ``*.exe`` at some point, Also this means that you can create your own tools using the correct file name and extension*.
*It is important to note that Autowall is simply a script that coordinates the behavior of MPV and Weebp. It has no dependencies on the files in the AutoWall/src/tools directory, and the extra features provided by these files are simply additional .exe binaries that are run at certain points. This means that you can create your own tools using any language or framework, as long as the resulting binary has the correct file name and extension.*

*In other words, the AutoWall/src/tools directory is optional and is not required for Autowall to function properly. You can choose to use the provided tools, create your own, or omit them entirely. Autowall will simply run the appropriate .exe file at the right time, regardless of its origin or implementation.*

To compile the extra tools in the [``AutoWall/src/tools/``](https://github.com/SegoCode/AutoWall/tree/master/src/tools) directory, follow these steps:

Navigate to the ``src/tools`` directory:
```bash
cd src/tools
```

First move to the folder ``cd src/tools``.
Compile the ``updater.go`` file using the golang compiler. This will create an updater.exe file:
```bash
go build updater.go
```

Run golang compiler ``go build updater.go``.
Install the necessary golang dependencies. These are required for the ``webView.go`` file to be compiled properly:
```bash
go install github.com/inkeliz/gowebview
```

Install golang dependences ``go install github.com/inkeliz/gowebview ``.
Compile the ``webView.go`` file. This will create a webView.exe file:
```
go build webView.go
```

Run golang compiler ``go build webView.go``.
Use [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) to compile the ``autoPause.au3`` file to x64. This will create an ``autoPause.exe```file.
Using [Aut2Exe](https://www.autoitscript.com/autoit3/docs/intro/compiler.htm) compile to x64 ``autoPause.au3``.
After completing these steps, you should have three .exe files in the tools directory: updater.exe, webView.exe, and autoPause.exe. Autowall is now ready to use with the extra features enabled.
__And now you will have three ``.exe`` in ``/tools``, Autowall is ready to use!__
## AutoPause.au3
> #### SegoCode at https://github.com/SegoCode/AutoWall/issues/19#issuecomment-955776642
Expand Down

0 comments on commit 94538d6

Please sign in to comment.