https://github.com/naelstrof/laser_pointer
Lets you point at people's screen remotely.
https://github.com/naelstrof/laser_pointer
Last synced: 26 days ago
JSON representation
Lets you point at people's screen remotely.
- Host: GitHub
- URL: https://github.com/naelstrof/laser_pointer
- Owner: naelstrof
- License: mit
- Created: 2024-03-04T23:29:52.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T23:48:41.000Z (over 2 years ago)
- Last Synced: 2025-02-22T07:16:41.698Z (over 1 year ago)
- Language: Rust
- Size: 251 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laser_pointer
https://github.com/naelstrof/laser_pointer/assets/1131571/caad58f2-53f0-4422-ab96-196db587efc1
An app designed to allow a tutor to point at things on a student's screen remotely. It's best paired with a streaming
app like discord.
## Features
Uses Steamworks for P2P traffic as a prototype, currently this app doesn't own an AppID. Use version 0.4.0 for direct IP connections.
Allows for multiple people to connect to the same student simultaneously, multiplayer pointing!
Customizable cursors, tutors can author a custom spritesheet for simple cursor animations and differentiation.
## Usage as a Student
Simply run laser_pointer by double-clicking on it, then share the ID it provides to the tutor. This requires a Steam account.
## Usage as a Tutor
If you're unfamiliar with command line utitilies, this might be hard! In the future I'm hoping to create a simple to use GUI front-end.
Start with installing the new Windows Terminal: [https://aka.ms/terminal](https://aka.ms/terminal) Make sure to allow it to add a context menu to your right-click during install!
Get the student's laser_pointer Steam ID. Then right-click on a blank space in explorer and hit "Open in Terminal"
Then type the following inside (you can right-click to paste):
```shell
.\laser_pointer.exe --steam-id=1479136419236129
```
but instead of `1479136419236129` use the Steam ID that the student gave you. Make sure to press enter to run it.
This should open a window that allows you to click to make a cursor appear on their screen.
## Customizing the cursor
Cursors are customized client-side, and sent to the server.
Cursors are loaded as a spritesheet with frames, horizontally stacked 64x64 images. Below is an example creature cursor that licks on right-click.
Animations are loaded via json, supporting 3 states, the idle state is ignored as it won't be visible. All animations are looped. Durations in seconds.
```json
{
"idle": {
"frames": [
{
"index": 0,
"duration": 1.0
}
]
},
"visible": {
"frames": [
{
"index": 0,
"duration": 1.0
}
]
},
"flashing": {
"frames": [
{
"index": 0,
"duration": 0.1
},
{
"index": 1,
"duration": 0.1
}
]
}
}
```
```shell
.\laser_pointer.exe --animation-json-path=./my_custom_animation_states.json
```