CircuitsAPI is a system to transmit data to Rec Room circuits.
Project description
THIS PROJECT IS IN PRE-ALPHA STAGE
This system has not been properly tested. It is constantly being updated with breaking changes. Do not use this system in a production environment. Only use it for testing and experimenting.
What is this?
A system to communicate with CV2 using Python.
Limitations
- You must sacrifice the following permission roles: host, moderator & contributor. Co-owner will be the only role you can grant others without triggering the system.
- Room owner & co-owners will not be able to receive data by this system.
- You can only send a single bit at once. This system is not applicable for big data transmissions.
- CV2 pongs require messing with the instance's matchmaking state.
- The circuits are currently made in Rooms v2 to prevent the system being used in existing production rooms due to instability.
- It will be ported over to Rooms v1 once it's stable enough.
Rec Room Setup
- Clone the template room: https://rec.net/room/CircuitsAPI.
- IMPORTANT: Remove any privileged permissions from the following roles from the room: host, moderator & contributor. Otherwise you may risk troublemakers abusing the privileges.
- Add
circuitsapi
as a room tag to indicate it's supported by the system. - Activate the 'Receiver' circuit board.
Installation
- Download and unpack the repository.
- Install the Python requirements.
pip install -U -r requirements.txt
- Include the
circuitsapi
directory in your project. That is the library.
Setup
Request a developer key from https://devportal.rec.net/. This will be passed as the dev_token
argument in the client.
Setup RecNetLogin: https://github.com/Jegarde/RecNet-Login/?tab=readme-ov-file#setup.
Quickstart
Here's the basics of setting up the client:
import circuitsapi
# Let's initialize the CircuitsAPI client!
# dev_token is the developer key from https://devportal.rec.net/.
# rr_auth is the RecNet access token. If left empty, CircuitsAPI defaults to RecNetLogin: https://github.com/Jegarde/RecNet-Login/
async with circuitsapi.Client(dev_token="", rr_auth=None) as client:
# Connect to a supported room
room = await client.connect_to_room(room="CircuitsAPI") # You can also use the room ID
# Connect to a specific user to send data to
user = await room.connect_to_user(user="Jegarde") # You can also use the account ID
# Send binary
await user.send_binary(101101)
# Send signals to the receiver ports
await user.send_bit_0()
await user.send_bit_1()
await user.send_end_signal()
Here's the functions you can use if you hook up the in-game 'Receiver' to the 'Packet Handler':
# Assuming you have connected to an user
# Sending text
await user.send_text_packet("Hello, World!")
# Sending integers
await user.send_int_packet(69420)
# Ping the in-game Packet Handler
await user.ping()
Here's some miscellaneous functions:
# Returns true if the player is in the specified room
# Requires 'rn.match.read' scope in access token.
await user.check_is_player_in_room()
# Returns the player's room instance data
await user.get_instance()
# Returns player IDs of those who have taken images in the past 10 minutes
# If you want to connect to users, you can ask them to take pictures and have the server check for those pictures
await room.find_players()
How does this work?
There's CV2 chips for checking if a player is a host, mod or a contributor and you can modify a player's roles through the API. This allows us to send remote signals to the specified player while CV2 is constantly checking for each players' roles.
RR Transmitter uses the following signals:
Host = Add on bit
Mod = Add off bit
Contributor = Repeat previous bit
No role = End of binary number
So if we wanted to transmit 1011 in binary numbers, the following signals would be sent:
>>> Modify [player] role to Host # Add on bit
>>> Modify [player] role to Mod # Add off bit
>>> Modify [player] role to Host # Add on bit
>>> Modify [player] role to Contributor # Add on bit (repeat previous bit)
>>> Modify [player] role to None # End of binary number
Modify role request
POST /rooms/{ROOM_ID}/roles/{PLAYER_ID} HTTP/1.1
Host: rooms.rec.net
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/x-www-form-urlencoded
role={0 | 10 | 20 | 25}
Requires an access token from an account with owner / co-owner in the specified room.
Role | ID |
---|---|
None | 0 |
Host | 10 |
Mod | 20 |
Contributor | 25 |
Co-owner | 30 |
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for circuitsapi-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f10acf51d7dff29d69559e9ea7b7b0337484e0291c6f3870dc7024e8a400f40 |
|
MD5 | 8dd6c19a5d39d86b3aef486d6910cb0c |
|
BLAKE2b-256 | c4863ad1b179b2e878d65ab031821cadbe51e59edc31e38412f6f894da806d45 |