Skip to content

Commit b76a845

Browse files
Copilotlevno-710
andcommitted
docs: refresh README visuals with preview gif and sample obfuscation output
Co-authored-by: levno-710 <62939318+levno-710@users.noreply.github.com> Agent-Logs-Url: https://github.com/prometheus-lua/Prometheus/sessions/bd5fce3b-e301-40ee-9ad4-586d297b35ca
1 parent 5610c2b commit b76a845

2 files changed

Lines changed: 25 additions & 3 deletions

File tree

81.9 KB
Loading

readme.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,43 @@
33
## Description
44
Prometheus is a Lua obfuscator written in pure Lua.
55

6-
This Project was inspired by the amazing [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator).
6+
This project was inspired by the amazing [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator).
77
It can currently obfuscate Lua51 and Roblox's LuaU, however LuaU support is not finished yet.
88

99
You can find the full Documentation including a getting started guide [here](https://levno-710.gitbook.io/prometheus/).
1010

1111
Prometheus has an official [Discord server](https://discord.gg/U8h4d4Rf64).
1212

13+
## Preview
14+
<p align="center">
15+
<img src="assets/readme/obfuscation-preview.gif" alt="Prometheus obfuscation process preview" width="900" />
16+
</p>
17+
18+
### Example output style
19+
```lua
20+
-- input.lua
21+
local secret = "Prometheus"
22+
local answer = 42
23+
print(secret .. " -> " .. answer)
24+
```
25+
26+
```lua
27+
-- (simplified) obfuscated output
28+
local lI1I, O0O = "\80\114\111...", 0x2A
29+
return (function(a, b)
30+
local t = string.char
31+
return print((a) .. " -> " .. b)
32+
end)(decode(lI1I), O0O)
33+
```
34+
1335
## Installation
14-
To install Prometheus, simply clone the Github Repository using:
36+
To install Prometheus, simply clone the GitHub repository using:
1537

1638
```batch
1739
git clone https://github.com/levno-710/Prometheus.git
1840
```
1941

20-
Alternatively you can download the Sources [here](https://github.com/prometheus-lua/Prometheus/archive/refs/heads/master.zip).
42+
Alternatively you can download the sources [here](https://github.com/prometheus-lua/Prometheus/archive/refs/heads/master.zip).
2143

2244
Prometheus also Requires LuaJIT or Lua51 in order to work. The Lua51 binaries can be downloaded [here](https://sourceforge.net/projects/luabinaries/files/5.1.5/Tools%20Executables/).
2345

0 commit comments

Comments
 (0)