├── .gitignore
├── FUNDING.yml
├── LICENSE
├── Readme.md
├── Readme.org
├── debug.gd
├── obfuscate.py
└── obfuscator
├── __init__.py
├── obfuscate.py
├── parser
├── LICENSE.txt
├── Readme.org
├── __init__.py
├── gdscript.lark
└── parser.py
└── reconstruct.py
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | .idea
3 | *.log
4 | tmp/
5 |
6 | *.py[cod]
7 | *.egg
8 | build
9 | htmlcov
10 | __pycache__
11 |
--------------------------------------------------------------------------------
/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: tavurth
2 | patreon: tavurth
3 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Readme.md:
--------------------------------------------------------------------------------
1 |
2 | # Table of Contents
3 |
4 | 1. [Usage](#org643df87)
5 | 1. [‼ Use this at your own risk ‼](#orgbe5b6ba)
6 | 2. [Dependencies](#orge2a7935)
7 | 3. [Running the obfuscator](#org8a51fc6)
8 | 4. [# no-mangle](#org9a38cdb)
9 | 5. [Examples](#org723a10b)
10 | 1. [Before](#orge4801dd)
11 | 2. [After](#org8379ffe)
12 | 2. [Support](#org734f3f2)
13 |
14 |
15 |
16 |
17 |
18 | # Usage
19 |
20 |
21 | This project was not really ready for production use and was more used as a way to show what might be possible.
22 |
23 | The proposal to read if you find this repository interesting:
24 | https://github.com/godotengine/godot-proposals/issues/4220
25 |
26 | Please do not attempt to use this to mangle your project files 🙏
27 |
28 |
29 |
30 |
31 |
32 | ## ‼ Use this at your own risk ‼
33 |
34 | This is very early work and this will mess up your game if you don’t have a git backup.
35 |
36 | Currently not production ready, built more as an example of what we could do for GDScript obfuscation
37 |
38 |
39 |
40 |
41 | ## Dependencies
42 |
43 | This currently uses `pt` ([platinum-searcher](https://github.com/monochromegane/the_platinum_searcher)) for quickly finding all of the references in the project.
44 | In the future we will probably move this to pure python.
45 |
46 |
47 |
48 |
49 | ## Running the obfuscator
50 |
51 | 1. Put this script in your game directory
52 | 2. Ensure `DRY_RUN` is `True` at the top of the file (only `prints` changes)
53 | 3. `python3 obfuscator.py`
54 |
55 |
56 |
57 |
58 | ## # no-mangle
59 |
60 | Currently `# no-mangle` keyword is supported only for function names
61 |
62 | func my_function(): # no-mangle
63 | pass
64 |
65 | Which will keep the name of the function intact
66 |
67 |
68 |
69 |
70 | ## Examples
71 |
72 |
73 |
74 |
75 | ### Before
76 |
77 | 
78 |
79 |
80 |
81 |
82 | ### After
83 |
84 | 
85 |
86 |
87 |
88 |
89 | # Support
90 |
91 | Currently this is something that I will work on when I have some free time. If you like this project and want me to work on it more, consider buying me a coffee ☕️
92 |
93 |
94 |
95 |
--------------------------------------------------------------------------------
/Readme.org:
--------------------------------------------------------------------------------
1 | #+TITLE: Godot GDScript Obfuscator
2 |
3 | * Usage
4 |
5 | ** ‼ Use this at your own risk ‼
6 |
7 | This is very early work and this will mess up your game if you don't have a git backup.
8 |
9 | Currently not production ready, built more as an example of what we could do for GDScript obfuscation
10 |
11 | ** Dependencies
12 |
13 | This currently uses ~pt~ ([[https://github.com/monochromegane/the_platinum_searcher][platinum-searcher]]) for quickly finding all of the references in the project.
14 | In the future we will probably move this to pure python.
15 |
16 | ** Running the obfuscator
17 |
18 | 1. Put this script in your game directory
19 | 2. Ensure ~DRY_RUN~ is ~True~ at the top of the file (only ~prints~ changes)
20 | 3. ~python3 obfuscator.py~
21 |
22 | ** # no-mangle
23 |
24 | Currently ~# no-mangle~ keyword is supported only for function names
25 |
26 | #+begin_src gdscript
27 | func my_function(): # no-mangle
28 | pass
29 | #+end_src
30 |
31 | Which will keep the name of the function intact
32 |
33 | ** Examples
34 |
35 | *** Before
36 | [[https://user-images.githubusercontent.com/100964/158587446-158ce369-cb4a-45ce-b8cd-7329df61e0df.png]]
37 |
38 | *** After
39 | [[https://user-images.githubusercontent.com/100964/158587624-b473b637-b3b2-4dd9-93dd-d725d48d1491.png]]
40 |
41 | * Support
42 |
43 | Currently this is something that I will work on when I have some free time. If you like this project and want me to work on it more, consider buying me a coffee ☕️
44 |
45 | @@html:
46 |
--------------------------------------------------------------------------------
/debug.gd:
--------------------------------------------------------------------------------
1 | tool
2 | extends Node
3 |
4 | func _input(event: InputEvent):
5 | if not event is InputEventKey:
6 | return
7 | if not event.pressed:
8 | return
9 |
10 | if event.is_action_pressed("debug_orphans"):
11 | print_stray_nodes()
12 |
13 |
14 | func test():
15 | """
16 | This is a header comment
17 | This is a header comment
18 | This is a header comment
19 | """
20 |
21 | #
22 | # This is a comment
23 | ## This is a comment
24 | var a = 5
25 | if a > 5:
26 | print("HERE")
27 | else:
28 | print("NOT HERE")
29 |
30 | while true:
31 | if a > 5:
32 | continue
33 |
34 |
35 | match a:
36 | 5:
37 | print("HERE")
38 | 10:
39 | print("Not HERE")
40 | _:
41 | print("Not HERE")
42 |
43 | a = 10
44 |
--------------------------------------------------------------------------------
/obfuscate.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | from obfuscator import obfuscate
4 |
5 | if __name__ == "__main__":
6 | obfuscate()
7 |
--------------------------------------------------------------------------------
/obfuscator/__init__.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | from .obfuscate import obfuscate
4 |
--------------------------------------------------------------------------------
/obfuscator/obfuscate.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import os
4 | import re
5 | from lark import Tree, Token
6 | from .parser import parser
7 | from .reconstruct import reconstruct
8 |
9 | DRY_RUN = True
10 |
11 | EXCLUDED_FILES = [os.path.basename(__file__)]
12 | EXCLUDED_TOKENS = [
13 | "_process",
14 | "_physics_process",
15 | "_ready",
16 | "_init",
17 | "_enter_tree",
18 | "_exit_tree",
19 | "_notification",
20 | "translated",
21 | "rotated",
22 | "basis",
23 | ]
24 |
25 |
26 | def find(to_search: str, only_files=True):
27 | to_ignore = " --ignore ".join([""] + EXCLUDED_FILES)
28 | to_append = '"'
29 |
30 | if only_files:
31 | to_append += " --files-with-matches"
32 |
33 | return (
34 | os.popen(
35 | 'pt --ignore "*.gltf" --nonumbers --nocolor --nogroup '
36 | + to_ignore
37 | + ' -e "'
38 | + to_search
39 | + to_append
40 | )
41 | .read()
42 | .split("\n")
43 | )
44 |
45 |
46 | def find_all_gdscript_files():
47 | to_return = find("(func |var | const | class )")
48 | return [i for i in to_return if ".gd" in i]
49 |
50 |
51 | def mangle(result: Tree):
52 | """
53 | Take in a lark tree and iterate through each
54 | name (function or variable) mangling them in turn
55 | """
56 | return result
57 |
58 |
59 | def obfuscate():
60 | for filename in find_all_gdscript_files():
61 | with open(filename, "r") as fin:
62 | file_data = fin.read()
63 |
64 | result = parser.parse(file_data)
65 | result = mangle(result)
66 | result = reconstruct(file_data, result)
67 |
68 | print(result)
69 |
--------------------------------------------------------------------------------
/obfuscator/parser/LICENSE.txt:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2019 Pawel Lampe
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/obfuscator/parser/Readme.org:
--------------------------------------------------------------------------------
1 | #+TITLE: Readme
2 |
3 |
4 | Files in this folder were originally found in the [[https://github.com/Scony/godot-gdscript-toolkit][godot-gdscript-toolkit]] repository.
5 |
6 | I have modified the sources, but their license remains intact and applies to only this subfolder.
7 |
--------------------------------------------------------------------------------
/obfuscator/parser/__init__.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | from .parser import parser # noqa: F401
4 |
--------------------------------------------------------------------------------
/obfuscator/parser/gdscript.lark:
--------------------------------------------------------------------------------
1 | start: _class_stmt+
2 |
3 | _class_stmt: (_simple_class_stmt _NL) | compound_class_stmt | _NL
4 | _simple_class_stmt: single_class_stmt (";" single_class_stmt)* [";"]
5 | ?single_class_stmt: tool_stmt
6 | | pass_stmt
7 | | signal_stmt
8 | | extends
9 | | classname_stmt
10 | | class_var_stmt
11 | | const_stmt
12 | | export_stmt
13 | | onready_stmt
14 | | puppet_var_stmt
15 | | docstr_stmt
16 | | classname_extends
17 | ?compound_class_stmt: class_def
18 | | enum_def
19 | | "static" func_def -> static_func_def
20 | | "remote" func_def -> remote_func_def
21 | | "remotesync" func_def -> remotesync_func_def
22 | | "master" func_def -> master_func_def
23 | | "mastersync" func_def -> mastersync_func_def
24 | | "puppet" func_def -> puppet_func_def
25 | | "puppetsync" func_def -> puppetsync_func_def
26 | | "sync" func_def -> sync_func_def
27 | | func_def
28 |
29 | tool_stmt: "tool"
30 | signal_stmt: "signal" NAME ["(" [NAME ("," NAME)* [trailing_comma]] ")"]
31 | extends: "extends" (NAME | string) ("." NAME)*
32 | classname_stmt: "class_name" NAME ["," string]
33 | !classname_extends: "class_name" NAME ["," string] "extends" (NAME | string) ("." NAME)*
34 | export_stmt: export_inf | export_typed
35 | export_inf: "export" [(puppet|onready)] (var_assigned | var_typed | var_typed_assgnd | var_inf) [setget]
36 | export_typed: "export" "(" TYPE ("," expr)* ")" [(puppet|onready)] class_var_stmt
37 | class_var_stmt: _var_stmt [setget]
38 | _var_stmt: var_empty
39 | | var_assigned
40 | | var_typed
41 | | var_typed_assgnd
42 | | var_inf
43 | var_empty: "var" NAME
44 | var_assigned: "var" NAME "=" expr
45 | _var_typed: "var" NAME ":" TYPE
46 | var_typed: _var_typed
47 | var_typed_assgnd: _var_typed "=" expr
48 | var_inf: "var" NAME ":" "=" expr
49 | !setget: "setget" (NAME ["," NAME] | "," NAME)
50 | !const_stmt: "const" NAME [":" [TYPE]] "=" expr
51 | onready_stmt: "onready" class_var_stmt
52 | puppet_var_stmt: "puppet" class_var_stmt
53 | puppet: "puppet"
54 | onready: "onready"
55 | docstr_stmt: string
56 |
57 | class_def: "class" NAME [extends] ":" (_class_body | _class_stmt)
58 | _class_body: _NL _INDENT _class_stmt+ _DEDENT
59 |
60 | func_def: func_header _func_suite
61 | func_header: "func" NAME "(" [func_args] ")" ["." parent_call] ["->" TYPE] ":"
62 | parent_call: _call_arglist
63 | func_args: func_arg ("," func_arg)*
64 | ?func_arg: func_arg_regular
65 | | func_arg_inf
66 | | func_arg_typed
67 | func_arg_regular: ["var"] NAME ["=" expr]
68 | func_arg_inf: ["var"] NAME ":" "=" expr
69 | func_arg_typed: ["var"] NAME ":" TYPE ["=" expr]
70 | _func_suite: _func_body
71 | | _func_stmt
72 | _func_body: _NL _INDENT _func_stmt+ _DEDENT
73 | _func_stmt: (_simple_func_stmt _NL) | compound_func_stmt
74 | _simple_func_stmt: single_func_stmt (";" single_func_stmt)* [";"]
75 | ?single_func_stmt: pass_stmt
76 | | return_stmt
77 | | func_var_stmt
78 | | break_stmt
79 | | continue
80 | | expression
81 | ?compound_func_stmt: if_stmt
82 | | while_stmt
83 | | for_stmt
84 | | match_stmt
85 | pass_stmt: "pass"
86 | return_stmt: "return" [expr]
87 | func_var_stmt: _var_stmt
88 | break_stmt.2: "break"
89 | continue.2: "continue"
90 | expression: expr
91 | if_stmt: if_branch (_NL? elif_branch)* [_NL? else_branch]
92 | if_branch: "if" expr ":" _func_suite
93 | elif_branch: "elif" expr ":" _func_suite
94 | else_branch: "else" ":" _func_suite
95 | while_stmt: "while" expr ":" _func_suite
96 | for_stmt: "for" NAME "in" expr ":" _func_suite
97 | match_stmt: "match" expr ":" _match_body
98 | _match_body: _NL _INDENT match_branch+ _DEDENT
99 | match_branch: pattern ":" _func_suite
100 |
101 | enum_def: (enum_regular | enum_named) _NL
102 | enum_regular: "enum" _enum_body
103 | enum_named: "enum" NAME _enum_body
104 | _enum_body: "{" [enum_element ("," enum_element)* [trailing_comma]] "}"
105 | enum_element: NAME ["=" test_expr]
106 |
107 | pattern: list_pattern
108 | ?list_pattern: test_pattern ("," test_pattern)*
109 | !?test_pattern: or_pattern ["if" or_pattern "else" test_pattern]
110 | !?or_pattern: and_pattern (("or" | "||") and_pattern)*
111 | !?and_pattern: not_pattern (("and" | "&&") not_pattern)*
112 | !?not_pattern: ("not" | "!") not_pattern | comp_pattern
113 | ?comp_pattern: bitw_or_pattern [_comp_op bitw_or_pattern]
114 | !?bitw_or_pattern: bitw_xor_pattern ("|" bitw_xor_pattern)*
115 | !?bitw_xor_pattern: bitw_and_pattern ("^" bitw_and_pattern)*
116 | !?bitw_and_pattern: shift_pattern ("&" shift_pattern)*
117 | !?shift_pattern: arith_pattern (("<<" | ">>") arith_pattern)*
118 | !?arith_pattern: mdr_pattern (("-" | "+") mdr_pattern)*
119 | !?mdr_pattern: neg_pattern (("*" | "/" | "%") neg_pattern)*
120 | !?neg_pattern: "-" neg_pattern
121 | | bitw_not_pattern
122 | !?bitw_not_pattern: "~" bitw_not_pattern
123 | | attr_pattern
124 | !?attr_pattern: atom_pattern ("." atom_pattern)*
125 | ?atom_pattern: "(" test_pattern ")" -> par_pattern
126 | | "var" NAME -> var_capture_pattern
127 | | ".." -> etc_pattern
128 | | "_" -> wildcard_pattern
129 | | array_pattern
130 | | dict_pattern
131 | | NAME
132 | | HEX
133 | | BIN
134 | | literal
135 | array_pattern: "[" [test_pattern ("," test_pattern)* [trailing_comma]] "]"
136 | dict_pattern: "{" [dict_pattern_element ("," dict_pattern_element)* [trailing_comma]] "}"
137 | ?dict_pattern_element: kv_pair_pattern
138 | | atom_pattern
139 | kv_pair_pattern: (c_dict_pattern_element | eq_dict_pattern_element)
140 | c_dict_pattern_element: test_pattern ":" test_pattern
141 | eq_dict_pattern_element: NAME "=" test_pattern
142 |
143 | expr: test_expr
144 | | assignment
145 | assignment: attr_expr _assnmnt_op test_expr
146 | !_assnmnt_op: "=" | "+=" | "-=" | "*=" | "/=" | "%=" | "&=" | "|=" | "^=" | ">>=" | "<<="
147 | !?test_expr: or_test ["if" or_test "else" test_expr]
148 | !?or_test: and_test (("or" | "||") and_test)*
149 | !?and_test: not_test (("and" | "&&") not_test)*
150 | !?not_test: ("not" | "!") not_test | content_test
151 | !?content_test: comparison ("in" comparison)*
152 | ?comparison: bitw_or [_comp_op bitw_or]
153 | !_comp_op: ">" | "<" | "==" | "!=" | "<=" | ">="
154 | !?bitw_or: bitw_xor ("|" bitw_xor)*
155 | !?bitw_xor: bitw_and ("^" bitw_and)*
156 | !?bitw_and: shift_expr ("&" shift_expr)*
157 | !?shift_expr: arith_expr (("<<" | ">>") arith_expr)*
158 | !?arith_expr: mdr_expr (("-" | "+") mdr_expr)*
159 | !?mdr_expr: neg_expr (("*" | "/" | "%") neg_expr)*
160 | !?neg_expr: "-" neg_expr
161 | | bitw_not
162 | !?bitw_not: "~" bitw_not
163 | | type_test
164 | !?type_test: type_cast ("is" type_cast)*
165 | !?type_cast: _call_expr ("as" TYPE)* // TODO: fix precedence (same as "is" probably(!))
166 | _call_expr: standalone_call
167 | | getattr_call
168 | | attr_expr
169 | !standalone_call: ["."] NAME _call_arglist
170 | !getattr_call: getattr _call_arglist
171 | !_call_arglist: "(" [test_expr ("," test_expr)*] ")"
172 | !?attr_expr: getattr
173 | | subscr_expr
174 | getattr: _call_expr _attr+
175 | !_attr: ("." NAME)
176 | ?subscr_expr: _call_expr "[" test_expr "]"
177 | | _plus_atom
178 | _plus_atom: ["+"] atom
179 | ?atom: "(" test_expr ")" -> par_expr
180 | | array
181 | | dict
182 | | NAME
183 | | HEX
184 | | BIN
185 | | literal
186 | ?literal: NUMBER
187 | | string
188 | | node_path
189 | | get_node
190 | HEX.2: /-?0x[a-fA-F0-9][a-fA-F0-9_]*/
191 | BIN.2: /-?0b[01][01_]*/
192 | node_path: "@" string
193 | get_node: "$" (path | string)
194 | path: NAME ("/" NAME)*
195 | array: "[" [test_expr ("," test_expr)* [trailing_comma]] "]"
196 | trailing_comma: ","
197 | dict: "{" [kv_pair ("," kv_pair)* [trailing_comma]] "}"
198 | kv_pair: (c_dict_element | eq_dict_element)
199 | c_dict_element: test_expr ":" test_expr
200 | eq_dict_element: NAME "=" test_expr
201 |
202 | TYPE: NAME ("." NAME)*
203 | NUMBER: ["+"|"-"] (FLOAT | INT)
204 | FLOAT: INT _EXP | DECIMAL _EXP?
205 | _EXP: ("e"|"E") SIGNED_INT
206 | SIGNED_INT: ["+"|"-"] INT
207 | DECIMAL: INT "." INT? | "." INT
208 | INT: DIGIT (DIGIT | "_")*
209 | DIGIT: "0".."9"
210 |
211 | string: LONG_STRING | REGULAR_STRING
212 | REGULAR_STRING: /("(?!"").*?(? NAME
227 |
--------------------------------------------------------------------------------
/obfuscator/parser/parser.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | """
4 | Initializes and caches the GDScript parsers, using Lark.
5 | Provides a function to parse GDScript code
6 | and to get an intermediate representation as a Lark Tree.
7 | """
8 | import os
9 | import pickle
10 | import sys
11 | import pkg_resources
12 |
13 | from lark import Lark, Tree, indenter
14 | from lark.reconstruct import Reconstructor
15 | from lark.grammar import Rule
16 | from lark.lexer import TerminalDef
17 |
18 |
19 | class Indenter(indenter.Indenter):
20 | NL_type = "_NL"
21 | OPEN_PAREN_types = ["LPAR", "LSQB", "LBRACE"]
22 | CLOSE_PAREN_types = ["RPAR", "RSQB", "RBRACE"]
23 | INDENT_type = "_INDENT"
24 | DEDENT_type = "_DEDENT"
25 | # TODO: guess tab length
26 | tab_len = 4
27 |
28 |
29 | # When upgrading to Python 3.8, replace with functools.cached_property
30 | class cached_property:
31 | """A property that is only computed once per instance and then replaces
32 | itself with an ordinary attribute. Deleting the attribute resets the
33 | property.
34 | """
35 |
36 | def __init__(self, func):
37 | self.__doc__ = func.__doc__
38 | self.func = func
39 |
40 | def __get__(self, obj, cls):
41 | if obj is None:
42 | return self
43 | value = obj.__dict__[self.func.__name__] = self.func(obj)
44 | return value
45 |
46 |
47 | class Parser:
48 | """Parses GDScript code using lark parsers.
49 | The parsers are only created once, upon using them for the first time.
50 | """
51 |
52 | def __init__(self):
53 | self._directory = os.path.dirname(__file__)
54 | self._use_grammar_cache = True
55 |
56 | def parse(self, code: str, gather_metadata: bool = False) -> Tree:
57 | """Parses GDScript code and returns an intermediate representation as a Lark Tree.
58 | If gather_metadata is True, parsing is slower but the returned Tree comes with
59 | line and column numbers for statements and rules.
60 | """
61 | code += "\n" # to overcome lark bug (#489)
62 | return (
63 | self._parser_with_metadata.parse(code)
64 | if gather_metadata
65 | else self._parser.parse(code)
66 | )
67 |
68 | def _get_parser(
69 | self,
70 | name: str,
71 | add_metadata: bool = False,
72 | grammar_filename: str = "gdscript.lark",
73 | ) -> Tree:
74 | version: str = pkg_resources.get_distribution("gdtoolkit").version
75 |
76 | tree: Tree = None
77 | grammar_filepath: str = os.path.join(self._directory, grammar_filename)
78 |
79 | tree = Lark.open(
80 | grammar_filepath,
81 | parser="lalr",
82 | start="start",
83 | postlex=Indenter(),
84 | propagate_positions=add_metadata,
85 | maybe_placeholders=False,
86 | )
87 |
88 | return tree
89 |
90 | @cached_property
91 | def _parser(self) -> Tree:
92 | return self._get_parser("parser")
93 |
94 | @cached_property
95 | def _parser_with_metadata(self) -> Tree:
96 | return self._get_parser("parser_with_metadata", add_metadata=True)
97 |
98 | @cached_property
99 | def _comment_parser(self) -> Tree:
100 | return self._get_parser(
101 | "parser_comments", add_metadata=True, grammar_filename="comments.lark"
102 | )
103 |
104 |
105 | parser = Parser()
106 |
--------------------------------------------------------------------------------
/obfuscator/reconstruct.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import re
4 | from math import inf
5 | from lark import Tree, Token
6 |
7 | TAB_MATCHER = re.compile(r"(\t)+[a-zA-Z]")
8 |
9 |
10 | def join_children(tree: Tree, join_by: str):
11 | to_return = ""
12 |
13 | for child in tree.children:
14 | if isinstance(child, Tree):
15 | to_return += construct(child) + join_by
16 |
17 | else:
18 | to_return += child + join_by
19 |
20 | return to_return.rstrip(join_by)
21 |
22 |
23 | def process_extends(tree: Tree):
24 | return "extends " + construct(tree, max=1) + "\n"
25 |
26 |
27 | def process_func_def(tree: Tree):
28 | return "func " + construct(tree, stop=1) + construct(tree, start=1)
29 |
30 |
31 | def process_func_header(tree: Tree):
32 | if "func_args" not in tree.pretty():
33 | return construct(tree, stop=1) + "():\n"
34 |
35 | return construct(tree, stop=1) + construct(tree)
36 |
37 |
38 | def process_func_args(tree: Tree):
39 | return "(" + construct(tree) + "):\n"
40 |
41 |
42 | def process_func_arg_typed(tree: Tree):
43 | return ",".join([i for i in tree.children if i.type == "NAME"])
44 |
45 |
46 | def process_if_branch(tree: Tree):
47 | return construct(tree, stop=1) + ":\n" + construct(tree, start=1)
48 |
49 |
50 | def process_if_stmt(tree: Tree):
51 | return "if " + construct(tree)
52 |
53 |
54 | def process_expr(tree: Tree):
55 | return construct(tree)
56 |
57 |
58 | def process_not_test(tree: Tree):
59 | return "not " + construct(tree, start=1)
60 |
61 |
62 | def process_type_test(tree: Tree):
63 | return join_children(tree, " ")
64 |
65 |
66 | def process_return_stmt(tree: Tree):
67 | return "return\n"
68 |
69 |
70 | def process_getattr(tree: Tree):
71 | return join_children(tree, "")
72 |
73 |
74 | def process_name(tree: Tree):
75 | return tree.value
76 |
77 |
78 | def process_getattr_call(tree: Tree):
79 | return construct(tree)
80 |
81 |
82 | def process_expression(tree: Tree):
83 | return construct(tree)
84 |
85 |
86 | def process_assignment(tree: Tree):
87 | return construct(tree)
88 |
89 |
90 | def process_standalone_call(tree: Tree):
91 | return join_children(tree, "") + "\n"
92 |
93 |
94 | def process_func_var_stmt(tree: Tree):
95 | return construct(tree)
96 |
97 |
98 | def process_while_stmt(tree: Tree):
99 | return "while " + construct(tree, stop=1) + ":\n" + construct(tree, start=1)
100 |
101 |
102 | def process_continue(_tree: Tree):
103 | return "continue\n"
104 |
105 |
106 | def process_var_assigned(tree: Tree):
107 | return "var " + construct(tree, stop=1) + "=" + construct(tree, start=1) + "\n"
108 |
109 |
110 | def process_comparison(tree: Tree):
111 | return join_children(tree, "")
112 |
113 |
114 | def process_else_branch(tree: Tree):
115 | return "else:\n" + construct(tree)
116 |
117 |
118 | def process_string(tree: Tree):
119 | return construct(tree, start=1)
120 |
121 |
122 | def process_tool_stmt(tree: Tree):
123 | return "tool\n"
124 |
125 |
126 | def process_match_stmt(tree: Tree):
127 | return "match " + construct(tree, start=1)
128 |
129 |
130 | def process_match_branch(tree: Tree):
131 | return construct(tree, stop=1) + ":\n" + construct(tree, start=1)
132 |
133 |
134 | def process_pattern(tree: Tree):
135 | return construct(tree)
136 |
137 |
138 | def process_pattern_wildcard(tree: Tree):
139 | return construct(tree)
140 |
141 |
142 | def process_default(tree: Tree):
143 | raise ValueError("No type to handle this case: " + str(tree))
144 |
145 |
146 | TREE_TYPES = {
147 | "assignment": process_assignment,
148 | "comparison": process_comparison,
149 | "continue": process_continue,
150 | "else_branch": process_else_branch,
151 | "expr": process_expr,
152 | "expression": process_expression,
153 | "extends": process_extends,
154 | "func_arg_typed": process_func_arg_typed,
155 | "func_args": process_func_args,
156 | "func_def": process_func_def,
157 | "func_header": process_func_header,
158 | "func_var_stmt": process_func_var_stmt,
159 | "getattr": process_getattr,
160 | "getattr_call": process_getattr_call,
161 | "if_branch": process_if_branch,
162 | "if_stmt": process_if_stmt,
163 | "match_branch": process_match_branch,
164 | "match_stmt": process_match_stmt,
165 | "name": process_name,
166 | "not_test": process_not_test,
167 | "pattern": process_pattern,
168 | "return_stmt": process_return_stmt,
169 | "standalone_call": process_standalone_call,
170 | "string": process_string,
171 | "tool_stmt": process_tool_stmt,
172 | "type_test": process_type_test,
173 | "var_assigned": process_var_assigned,
174 | "while_stmt": process_while_stmt,
175 | "wildcard_pattern": process_pattern_wildcard,
176 | }
177 |
178 |
179 | def construct(tree: Tree, **kwargs):
180 | to_return = ""
181 |
182 | start = kwargs.get("start", 0)
183 | stop = kwargs.get("stop", inf)
184 | stop = min(stop, len(tree.children))
185 |
186 | for idx in range(start, stop):
187 | item = tree.children[idx]
188 |
189 | if isinstance(item, Tree):
190 | to_return += TREE_TYPES.get(item.data, process_default)(item)
191 |
192 | else:
193 | to_return += item.value
194 |
195 | return to_return
196 |
197 |
198 | def cleanup(original: str):
199 | """
200 | Handles the replacement of common GDScript patterns
201 | Removing newlines and compressing the script in general
202 | """
203 | # Remove comments
204 | original = re.sub(r"\t+#.*\n", "", original)
205 |
206 | # Remove comment headers
207 | original = re.sub(r'([\'"])\1\1(.*?)\1{3}', "", original, flags=re.DOTALL)
208 |
209 | # Remove multiple newlines
210 | original = re.sub(r"^\t?\n", "", original, flags=re.MULTILINE)
211 |
212 | # Always put return on a newline
213 | # original = re.sub(r"((\t)+.*:\s?return)", ":")
214 |
215 | return original
216 |
217 |
218 | def reconstruct(original: str, tree: Tree, **kwargs):
219 | to_return = []
220 |
221 | constructed = construct(tree)
222 | split_original = cleanup(original).split("\n")
223 | split_construct = constructed.split("\n")
224 |
225 | for idx in range(len(split_construct)):
226 | tabs = TAB_MATCHER.search(split_original[idx])
227 | if not tabs:
228 | to_return.append(split_construct[idx])
229 | continue
230 |
231 | line = "\t" * (tabs.end() - tabs.start())
232 | line += split_construct[idx]
233 |
234 | to_return.append(line)
235 |
236 | return "\n".join(to_return)
237 |
--------------------------------------------------------------------------------