|
1 | | -# Wire-FPGA |
| 1 | +# Wiremod [](LICENSE) [](https://discord.gg/H8UKY3Y) [](https://steamcommunity.com/sharedfiles/filedetails/?id=160250458) |
2 | 2 |
|
3 | | -Adds a field programmable gate array for use with Wiremod (https://github.com/wiremod/wire) |
| 3 | +> An addon for [Garry's Mod](https://garrysmod.com) which adds entities that communicate via wires. It can be used to create robots, vehicles, computers and much more! |
4 | 4 |
|
5 | | -Workshop: https://steamcommunity.com/sharedfiles/filedetails/?id=2384925255 |
| 5 | +## ⬇️ Installation |
6 | 6 |
|
7 | | -Comes with a visual node editor, and offers a nice step between pure wire gates and E2, |
8 | | -but also makes stuff like custom CPUs and other complicated gate devices possible, since the performance hit is several times lower than |
9 | | -multiple gates being used to make the same device. |
| 7 | +| Addon | Workshop | GitHub | |
| 8 | +| --- | --- | --- | |
| 9 | +|**Wiremod** (Stable) | [](https://steamcommunity.com/sharedfiles/filedetails/?id=160250458) | https://github.com/wiremod/wire | |
| 10 | +|**Wiremod** (Canary) | [](https://steamcommunity.com/sharedfiles/filedetails/?id=3066780663) | https://github.com/wiremod/wire | |
| 11 | +|**AdvDupe2**| [](https://steamcommunity.com/sharedfiles/filedetails/?id=773402917)| https://github.com/wiremod/advdupe2 | |
| 12 | +|**Wire Extras**| [None yet](https://github.com/wiremod/wire-extras/issues/113) | https://github.com/wiremod/wire-extras | |
10 | 13 |
|
| 14 | +For git, inside of `steamapps/common/Garrysmod/garrysmod/addons`, run ``git clone https://github.com/wiremod/wire``. |
11 | 15 |
|
12 | | -## Source code modifications |
13 | | -Part of this mod (namely the editor-frame) is based on the Expression 2 / ZCPU editor (lua\wire\client\text_editor\wire_expression2_editor.lua) that comes with Wiremod. This part has been changed to fit the usage seen here, but the base of the code remains the same as the versions shipped with Wiremod (as of 2021-01-08). |
| 16 | +## 📖 Documentation |
14 | 17 |
|
15 | | -The frame (the part outside the text editor, ie. the file selector, the tabs, the menus) has been changed to make it compatible with saving and loading node based files, and offer more relevant settings that the node editor would use. This involved changing the helper functions that get the "name" of the program from the editor, getting the data (text) from the editor, loading data into the editor, loading the editor itself (node editor). |
16 | | -Various other changes have been made, to remove ZCPU and E2 specific functionality which was no longer needed. |
| 18 | +You can find documentation [on our wiki](https://github.com/wiremod/wire/wiki)! |
17 | 19 |
|
18 | | -The gate selector from the Wire Gate tool has been put to use in the node editor, and the searching function has modified to fit the expanded gate library that Wire FPGA brings. |
19 | 20 |
|
20 | | -The vector/angle validation function from the Wire Value tool has been used in the node edit menu, when changing vector/angle constant values. |
| 21 | +## 🤝 Contributing |
| 22 | + |
| 23 | +> Before contributing to wiremod, take a look at the [code of conduct](https://github.com/wiremod/wire/blob/master/CODE_OF_CONDUCT.md). |
| 24 | +
|
| 25 | +### 💡 Suggestions |
| 26 | + |
| 27 | +To submit a suggestion, [use the discussions page](https://github.com/wiremod/wire/discussions/new?category=suggestions). |
| 28 | + |
| 29 | +### 🐛 Bug Reports |
| 30 | + |
| 31 | +To submit a bug report, [make an issue](https://github.com/wiremod/wire/issues/new/choose). |
| 32 | + |
| 33 | +### 🧑💻 Pull Requests |
| 34 | + |
| 35 | +Before making a PR, ensure your code follows the [developer style guide](https://github.com/wiremod/wire/wiki/Developer-Style-Guide). |
0 commit comments