Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

Commit

Permalink
1.3.0
Browse files Browse the repository at this point in the history
- Documentation relating to resizing rectangles added
- Documentation relating to fading images in and out added
- Introduction to Wireshark added
- Example file for Wireshark added
  • Loading branch information
AutumnRivers committed May 31, 2024
1 parent d280912 commit 1763e0c
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ Gone are the days of listening to the same song on repeat during a long mission,
Get your golden funky groove on and grab yourself a copy of **RadioV3**!

### `Wireshark` / `#WIRESHARK_EXE#`
![Wireshark Example](./docs/images/wireshark_example.jpg)

Based off of the [real-life program of the same name](https://www.wireshark.org/), Wireshark allows you to capture network traffic on certain nodes. It works similarly to `MemForensics`. Wireshark can also be used to "capture" packets on certain nodes by passing `--capture` to the executable. Admin access is required to capture traffic.

Based off of the [real-life program of the same name](https://www.wireshark.org/), Wireshark allows you to capture network traffic on certain nodes. It works similarly to `MemForensics`.
Please refer to [this example file](./docs/examples/wireshark_pc_example.xml) for more information.

---

Expand Down
17 changes: 17 additions & 0 deletions docs/cutscenes/Cutscene_Instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Let's lay some ground rules:
<!-- Show Image -->
<ShowImage id="string" delay="float"/>
<HideImage id="string" delay="float"/>

<!-- Images can also be faded in and out -->
<FadeInImage id="string" duration="float" delay="float"/>
<FadeOutImage id="string" duration="float" delay="float"/>
```
Shows/hides the given object, respectively.

Expand Down Expand Up @@ -80,3 +84,16 @@ When `forever` is set to `true`, then the image will continue to be rotated at a
```
Stops the current rotation for the image with the id of `id`.

## Resizing
### Resize Rectangle
```xml
<ResizeRectangle id="string" resizeTo="float,float" maintainAspect="bool" tween="bool" tweenDuration="float" delay="float" />
```
Resizes a rectangle to `resizeTo`.

* `resizeTo` - The target size for the rectangle, formatted as [Vector2](https://learn.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199660(v=xnagamestudio.35)).
* `maintainAspect` - Whether or not to maintain the aspect ratio of the rectangle when resizing.
* `tween` - Whether or not to tween between the current size and the new size.
* `tweenDuration` - How long it should take for the tweening animation to complete, in seconds. This is only required if `tween` is set to true.

More cutscene features will be added in the future.
30 changes: 30 additions & 0 deletions docs/examples/wireshark_pc_example.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version = "1.0" encoding = "UTF-8" ?>
<Computer id="wiresharkExample" name="Bitwise Test PC" type="4" icon="laptop" security="2" allowsDefaultBootModule="true">

<file path="bin" name="Wireshark.exe">#WIRESHARK_EXE#</file>

<!-- Pre-Defined file - player can view this right away so long as they have admin permissions on the node -->
<wiresharkCapture path="home" name="testcapture.pcap">
<pcap id="12" from="127.0.0.1" to="192.168.1.1" method="GET" protocol="TCP" secure="false">el horso</pcap>
<pcap id="392" from="127.0.0.1" to="192.168.1.1" method="POST" protocol="TCP" secure="false">god damn you half-japanese girls
do it to me every time
oh the redhead said you shred the cello
and i'm jell-o, baby</pcap>
<pcap id="183" from="127.0.0.1" to="192.168.1.1" method="GET" protocol="TCP" secure="false">you just lost the game</pcap>
<pcap id="420" from="127.0.0.1" to="192.168.1.1" method="GET" protocol="DNS" secure="false"></pcap>
<pcap id="123" from="127.0.0.1" to="192.168.1.1" method="POST" protocol="SSL" secure="true">This is a secure file!</pcap>
</wiresharkCapture>

<!--
Secure packets are a bit funky. The player must have admin permissions on the computer that the file came from, and the file must be on the same computer.
If the player does not have admin permissions or is on another computer then, the packet will state it is encrypted and cannot be viewed.
It's a bit confusing, but it can add some new challenge.
-->

<!-- These are captured by passing the capture launch argument to the executable. -->
<WiresharkEntries>
<pcap id="1" from="127.0.0.1" to="1.1.1.1" method="PUT" protocol="TCP" secure="false">This node has been wiresharked!</pcap>
<pcap id="45" from="127.0.0.1" to="2.2.2.2" method="POST" protocol="UDP" secure="true">This is a secure packet... hush!</pcap>
</WiresharkEntries>

</Computer>
Binary file added docs/images/wireshark_example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1763e0c

Please sign in to comment.