Skip to content

Commit a78880a

Browse files
authored
Merge pull request #219 from prometheus-lua/copilot/improve-readme-visuals
Refresh README visuals with real obfuscation terminal GIF and Medium preset output excerpt
2 parents deb4615 + 22770c1 commit a78880a

2 files changed

Lines changed: 23 additions & 3 deletions

File tree

372 KB
Loading

readme.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,41 @@
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+
```text
27+
-- generated with: lua ./cli.lua --preset Medium ./simple.lua
28+
-- excerpt from ./simple.obfuscated.lua
29+
return(function(...)local L={"afT6mf1V","/7mJXsuvmE1c/fT3";"tn1ZSn6=","37ghSJM=";"WqermfWAWuuZpb3XX7M=","tqXGSJ3u","XQXpL9x21dxAWJa//p==","SrM=";"3q+5SJM=","/D==";"t7XUt0p=";"mIeOmIx9";"LdgrBfWdWuNABsb+KJxj","SJWJ4dahKsebW7t+KQv=","/cDu3AvP/D==";"Llv7uD==","tJWhFfTE";"TQ43ctIuy9HIop==","mEu93p==";"WJax1sXEXEaxWuxGt6==","t0gPSEp=",...
30+
... (remaining obfuscated output omitted)
31+
```
32+
1333
## Installation
14-
To install Prometheus, simply clone the Github Repository using:
34+
To install Prometheus, simply clone the GitHub repository using:
1535

1636
```batch
1737
git clone https://github.com/levno-710/Prometheus.git
1838
```
1939

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

2242
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/).
2343

0 commit comments

Comments
 (0)