Skip to content

Commit ac31e10

Browse files
authored
Added FAQs section
1 parent d7d6f56 commit ac31e10

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,40 @@ If you use this plugin, please let us know, we'd love to see what you've done wi
4040

4141
---
4242

43+
**FAQs:**
44+
---
45+
46+
**Q: Does RealtimeCSG support runtime editing?**
47+
48+
* A: **No.** RealtimeCSG does **not** support or have API for runtime editing. This does not stop you from using the native binary to create your own bindings to use. We do not provide support for that, so you are on your own in doing this. If you are unsure where to start, [then you can check out the native folder](https://github.com/LogicalError/realtime-CSG-for-unity/tree/master/Plugins/Editor/Scripts/Control/Bindings), which has the bindings that RealtimeCSG uses.
49+
50+
**Q: How do I turn RealtimeCSG off in the editor?**
51+
52+
* A: Simply press CTRL+F3 to toggle it!
53+
54+
**Q: Can I use RealtimeCSG to edit other meshes?**
55+
56+
* A: No. RealtimeCSG is intended to work with its own brushes, which generates its own output mesh. It cannot be used for that purpose.
57+
58+
**Q: Can I have access to the native C++ code?**
59+
60+
* A: No. Unless stated otherwise, it will not be available to the public. Sorry for that.
61+
62+
**Q: Is there a build of the native binary for <x> distro?**
63+
64+
A: RealtimeCSG currently supports the following platforms:
65+
- Windows x64
66+
- MacOS
67+
68+
There are plans and work being done in the background to bring support to Linux. This does not mean it will support *all* linux distros. Just the popular ones like Debian, Ubuntu, Mint, etc.
69+
70+
Unsupported platforms:
71+
- Any ARM platforms. We don't have access to an ARM system. This may/may not change if one of us gets one, but it is unlikely.
72+
73+
**Q: Can I build RealtimeCSG for another OS?**
74+
75+
* A: See "Can I have access to the native C++ code?".
76+
4377
**Links:**
4478
---
4579

@@ -56,4 +90,4 @@ If you use this plugin, please let us know, we'd love to see what you've done wi
5690
* Create your own branch
5791
* Submit a PR (do not submit PRs from the master branch of your fork)
5892

59-
<sub>README last updated June 9th, 2022</sup>
93+
<sub>README last updated August 9th, 2023</sub>

0 commit comments

Comments
 (0)