utf-4096 / butterspades

BetterSpades-based Ace of Spades client aiming to improve look and feel.

ButterSpades

Windows: 64bit - 32bit

ButterSpades is a fork which aims to improve the overall UI and feel of BetterSpades.

What's different

• In-game settings/controls menu
• Better UI scaling (HUD/Main UI)
• Configurable UI background and color accents
• Chat colors and killfeed (OpenSpades compatible)
• Adaptive chat size
• HUD shadows
• Spectator Y-Clamp

Previews

Apocalypse on Babel	Babel	Chat
Player list	Customizable UI	Background and color scheme

System requirements

Type	min. requirement
OS	Windows 98 or Linux
CPU	1 GHz single core processor
GPU	64MB VRAM, Mobile Intel 945GM or equivalent
RAM	256MB
Display	800x600px
Others	Keyboard and mouse Dial up network connection

Build requirements

This project uses the following libraries and files:

Name	License	Usage	GitHub
GLFW3	ZLib	OpenGL context	Link
OpenAL soft	LGPL-2.1	3D sound environment	Link
inih	BSD-3.Clause	.INI file parser	Link
stb_truetype	Public domain	TrueType font renderer	Link
dr_wav	Public domain	wav support	Link
http	Public domain	http client library	Link
LodePNG	MIT	png support	Link
libdeflate	MIT	decompression of maps	Link
enet	MIT	networking library	Link
parson	MIT	JSON parser	Link
log.c	MIT	logger	Link
GLEW	MIT	OpenGL extensions	Link
hashtable	MIT	hashtable	Link
libvxl	MIT	access VXL format	Link
microui	MIT	user interface	Link

You will need to compile the following by yourself, or get hold of precompiled binaries:

• GLFW3
• GLEW
• OpenAL soft (only needed on Windows)
• libdeflate
• enet

Follow the instructions on their project page, then place produced static libraries in deps/.

All other requirements of the above list (like single file libs) will be downloaded by CMake automatically and don't need to be taken care of. Because state of copyright of 0.75 assets is unknown, CMake will also download additional assets from here which are not part of this repository.

Windows

This project uses CMake to generate all Makefiles automatically. It's best to use MinGW-w64 for GCC on Windows. You can generate the required files by opening cmd.exe in the build/ directory and typing:

cmake -G "MinGW Makefiles" ..
mingw32-make

If everything went well, the client should be in the build/BetterSpades/ subfolder.

When starting client.exe, you will be greeted by a server list. Select a server on it to start playing! You can also start the client the same way as you did with the voxlap version by opening cmd and putting an aos:// link in as the first argument:

client.exe -aos://16777343:32887 //Connects to a local server

Linux

Compilation now works the same on Linux. Just change the build system to Unix Makefiles or leaving it as default will work too (cmake ..).

You can build each library yourself, or install them with your distro's package manager:

sudo apt install libgl1-mesa libgl1-mesa-dev libopenal1 libopenal-dev libglfw-dev libenet-dev libglew-dev

(this does not include libdeflate which is a requirement too, see Wiki/Building for more details)

Start the client e.g. with the following inside the build/bin/ directory:

./client

Or connect directly to localhost:

./client -aos://16777343:32887

macOS

The same instructions for Linux work on macOS aside from some minor differences. First, use Homebrew or MacPorts to grab dependencies:

brew install glfw enet

The development headers for OpenAL and OpenGL don't have to be installed since they come with macOS by default. libdeflate should be installed and placed manually in a way similar to Linux. See Wiki/Building for more details.

butterspades's Issues

Fix the kamikaze bug

already fixed in upstream betterspades

Score names should indicate whether or not a player is alive

The colour of the score name remains the same, normally there would've been an indication through the darkening of the text but now it doesn't

Add a way to copy chat messages

Will require some manual mouse work.
Reported by @X-DE1

Move the FPS display to another position

Currently it gets hidden when opening chat to badly avoid overlapping with it.

Fix chat noclip

See xtreme8000/BetterSpades#154

Misaligned UI icons when spacing/padding are changed

Happens because BS uses a fixed spacing for icons instead of based on spacing and padding

Long messages get cut off

Add an option to change the chat size, and implement word wrapping.
Reported by @X-DE1

Chat messages take up almost the whole entire screen (feat-microui-rewrite branch)

Implement gamemode integrations

Gamemode integrations would, as the name implies, integrate specific parts of a gamemode in the client UI.
Some mockups of how gamemodes would look like:

Babel

Show the name of the player who is holding the intel. The player's name would also match the color of their team.

Implementation

Using the IntelPickup packet.

Arena

Show the number of players who are still alive for each team.
Countdown should also be shown here when the round hasn't started, and then being replaced with the number of alive players instead when it starts.
Round ends would show the winning team only, or maybe making the other team be grayed out (and reset when the next round starts).

Implementation

Scraping the chat messages for countdown, using the regular player list for alive count.
Possibly using a protocol extension for countdown, if it gets decided.

Autologin

Have an option to automatically send /login username password or /login password when joining a specific server (based on aos:// URL)

TODO: Features to implement

TODO

• Fix crash when connecting to a 0.76 server from server list
• Add exit button in main menu
• Make newest messages appear from the bottom when chat is opened (toggleable in config)
• Let settings be changed in-game
• Allow Y-Clamp in spectator
• Add smooth camera in spectator
• Add configurable fly speed
• Add toggleable spectator xray
• Add toggleable name and health display in spec

Make more spectator controls customizable

Controls like V and middle mouse button are not currently customizable.
Reported by @X-DE1

Chat Log and Change Spectator Mode Controls

It would be great if you add chat log to copy text and the option to change spectator mode controls the V and mouse wheel button.
It would also be great if you put a width limit on the chat box since then people write very long texts that cover the whole screen and you can't read the whole message.

Config not saving properly

Seems to occur since the config.default.ini update, need to investigate further

Provide builds for macOS as well as a Linux tarball

FPS drop upon opening chat

Has been reported by multiple people, have been unable to reproduce it yet.