-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Remote Console HowTo
Alex Peterson edited this page Dec 4, 2023
·
1 revision
The Open 3D Engine includes a Python module for communicating with the client or server runtime while it is running. This is especially useful for controlling servers and development on external devices like mobile, vr and consoles.
To use the remote console module in the O3DE Python REPL,
- Start up your game client or launcher
- Open a command window or terminal
- Navigate to where O3DE is installed
- Run the O3DE
Python.cmd
to start Python and use theRemoteConsole
object.
c:\o3de > python\python.cmd
Python 3.10.5 (tags/v3.10.5-dirty:f377153, Jul 23 2022, 05:17:26) [MSC v.1916 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import ly_remote_console.remote_console_commands as remote_console_commands
>>> console = remote_console_commands.RemoteConsole(addr='127.0.0.1',port=4600)
>>> console.start()
>>> console.send_command('loadlevel defaultlevel')
>>> console.send_command('r_displayinfo 2')
>>> console.stop()
The RemoteConsole
object takes an addr
parameter which should be the IP address of your client or server launcher. The default port
is 4600.
Use the send_command
message to send commands to the server.
- GPU Crash Debugging and Reporting
- CPU & GPU Debugging Tools
- CPU Profiling Tools
- GPU Profiling Tools
- GPU Memory Profiling
- Faster Shader Iteration
- Commit sign off
- PerformanceCollector API
- Allocator Tagging Guide
- What happens when entering/exiting Game mode?
- Hello World
- Using Tick Bus
- Using Transform Bus
- Reflecting Properties to the Editor
- Working With An External Lua Debugger
- Attachment Images and Buffers
- Image Builder
- Scene And Render Pipeline
- Shader Management Console (SMC)
- Work With Passes In Gems
- Developer Guide: Shader Build Arguments Customization
- Developer Guide: Customize AZSLc Executable
- Collecting Graphics Performance Metrics
- Mesh Instancing: For Content Creators
- Mesh Instancing: For Shader Authors
- Mesh Instancing: For Engine Maintainers/Contributors
- Screen Capture Image Comparison Testing