SAMP CEF

This project embeds CEF into SA:MP expanding abilities to express yourself with beauty in-game interfaces using HTML / CSS / JavaScript.

It is a FRAMEWORK (or SDK), not something that you download and use. To be able to create you should have some webdev basics (JS / HTML / CSS).

What you can do

• Create browser views from a gamemode or from client-side plugins (C ABI).
• Place browsers on objects (with kind-of spatial sound)
• Send and receive custom defined events from / to clients.

Crates

• cef - Rust wrappers around CEF C API.
• cef-api - Rust wrappers to build client plugins using CEF.
• cef-interface - example of a Rust plugin.
• cef-sys - bindings for CEF C API.
• client - client CEF plugin.
• d3dx9 - bindings to DirectX SDK.
• loader - small loader that makes it work (should be named cef.asi).
• messages - protobuf messages to communicate with server on net.
• network - quinn glue (laminar like).
• proto - raw proto files.
• renderer - glue between CEF renderer process and main logic.
• server - server side plugin.
• server-core - shared server logic used by the SA:MP plugin and open.mp component.
• openmp-component - native open.mp component built through CMake and cxx.

Download

Latest builds from the master branch are placed in the Actions.

Currently there is those OS:

• CentOS 7 (cef-centos-7.so)
• Debian 9, 10, 11 (cef-debian-*.so)
• Ubuntu 18.04, 20.04 (cef-ubuntu-*.so)
• Windows (cef-windows.dll)

And also all client-side parts (cef.asi, client.dll, renderer.exe).

Building

Dependencies

• Rust compiler (nightly) with i686-windows-pc-msvc toolchain
• Prebuilt CEF with proprietary codes (if you wanna use streams). I had one for you in releases. (Client only)
• Environment variable CEF_PATH that points to libcef.lib (client only).
  • In powershell it's like $env:CEF_PATH="C:/some/path"
  • Then build
• DirectX SDK (June 2010) for client builds; set DX_SDK to DXSDK/Lib/x86.

Notes ...

If you get a linker error, you should change hard-coded links in the source code

• client/build.rs - path to DirectX SDK (default one)

Running Rust

and now

rustup toolchain install nightly-2022-11-06-i686-pc-windows-msvc
cargo build --release

Building the open.mp component

Use the helper script from the repository root:

scripts/build-openmp-component.sh --openmp-root /path/to/open.mp
scripts/build-openmp-component.sh --openmp-root /path/to/open.mp --server-root /path/to/omp-server

It builds openmp-component and installs it into <server>/components when --server-root is provided. More details are in docs/build.md and openmp-component/README.md.

Cross-compiling the Windows client (macOS/Linux)

Use scripts/build-client-win32.sh to build client, renderer, and loader for i686-pc-windows-msvc on non-Windows hosts. It relies on cargo-xwin (cargo install cargo-xwin --locked), 7z for extracting the DirectX SDK, and downloads libcef.lib if CEF_PATH is not set. The script can also download/extract the DirectX SDK if DX_SDK is not set.

also the client plugin can be built using OpenAL for sound (rodio by default). to do that compile the client without default features. for example:

cargo +nightly-i686 build --release --package client --no-default-features

to make it work you should place openal.dll as sound.dll in the cef folder. I do not remember what version is used exactly ... but I have it on the release page.

to build specific part you can add --package <NAME>

for example if you will try to build ALL crates on linux, you will get an error. so, pass --package server to build only server on linux.

CEF version

Current versions of CEF and Chromium: 89.0.5+gc1f90d8+chromium-89.0.4389.40 release branch 4389

Date:             February 26, 2021

CEF Version:      89.0.5+gc1f90d8+chromium-89.0.4389.40
CEF URL:          https://bitbucket.org/chromiumembedded/cef.git
                  @c1f90d8c933dce163b74971707dbd79f00f18219

Chromium Version: 89.0.4389.40
Chromium URL:     https://chromium.googlesource.com/chromium/src.git
                  @2c3400a2b467aa3cf67b4942740db29e60feecb8

Docs

• docs/main_ru.md
• docs/main_en.md (it's better to google translate russian one ...)
• Also, check out wiki on github.

Video examples

• https://www.youtube.com/watch?v=Jh9IBlOKoVM (гоблин на весь дом)
• https://www.youtube.com/watch?v=jU-O8_t1AfI (простые интерфейсы)
• https://www.youtube.com/watch?v=qs7n8LoVYs4 (кастомный интерфейс гта)
• https://www.youtube.com/watch?v=vcyTjn3RJhs (голосовой чят)
• https://www.youtube.com/watch?v=6OnCSHKcOGU (кухня по телеку)

BIG TODO: EXAMPLES

But it's similar to fivem or ragemp implementations.