veloren/voxygen/src/settings.rs

use crate::window::KeyMouse;
use config::{Config, ConfigError};
use directories::ProjectDirs;
use glutin::{MouseButton, VirtualKeyCode};
use serde_derive::{Deserialize, Serialize};
use std::{fs, io::prelude::*, path::PathBuf};
use toml;

/// `Settings` contains everything that can be configured in the Settings.toml file.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(default)]
pub struct Settings {
    pub controls: ControlSettings,
    pub networking: NetworkingSettings,
    pub log: Log,
    pub graphics: GraphicsSettings,
    pub audio: AudioSettings,
}

/// `ControlSettings` contains keybindings.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ControlSettings {
    pub toggle_cursor: KeyMouse,
    pub escape: KeyMouse,
    pub enter: KeyMouse,
    pub move_forward: KeyMouse,
    pub move_left: KeyMouse,
    pub move_back: KeyMouse,
    pub move_right: KeyMouse,
    pub jump: KeyMouse,
    pub glide: KeyMouse,
    pub map: KeyMouse,
    pub bag: KeyMouse,
    pub quest_log: KeyMouse,
    pub character_window: KeyMouse,
    pub social: KeyMouse,
    pub spellbook: KeyMouse,
    pub settings: KeyMouse,
    pub help: KeyMouse,
    pub toggle_interface: KeyMouse,
    pub toggle_debug: KeyMouse,
    pub fullscreen: KeyMouse,
    pub screenshot: KeyMouse,
    pub toggle_ingame_ui: VirtualKeyCode,
    pub pan_sensitivity: f32,
    pub zoom_sensitivity: f32,
    pub attack: KeyMouse,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct NetworkingSettings {
    pub username: String,
    pub servers: Vec<String>,
    pub default_server: usize,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Log {
    pub file: PathBuf,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct GraphicsSettings {
    pub view_distance: u32,
}

/// AudioSettings controls the volume of different audio subsystems and which
/// device is used.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct AudioSettings {
    pub music_volume: f32,
    pub sfx_volume: f32,

    /// Audio Device that Voxygen will use to play audio.
    pub audio_device: Option<String>,
}

impl Default for Settings {
    fn default() -> Self {
        Settings {
            controls: ControlSettings {
                toggle_cursor: KeyMouse::Key(VirtualKeyCode::Tab),
                escape: KeyMouse::Key(VirtualKeyCode::Escape),
                enter: KeyMouse::Key(VirtualKeyCode::Return),
                move_forward: KeyMouse::Key(VirtualKeyCode::W),
                move_left: KeyMouse::Key(VirtualKeyCode::A),
                move_back: KeyMouse::Key(VirtualKeyCode::S),
                move_right: KeyMouse::Key(VirtualKeyCode::D),
                jump: KeyMouse::Key(VirtualKeyCode::Space),
                glide: KeyMouse::Key(VirtualKeyCode::LShift),
                map: KeyMouse::Key(VirtualKeyCode::M),
                bag: KeyMouse::Key(VirtualKeyCode::B),
                quest_log: KeyMouse::Key(VirtualKeyCode::L),
                character_window: KeyMouse::Key(VirtualKeyCode::C),
                social: KeyMouse::Key(VirtualKeyCode::O),
                spellbook: KeyMouse::Key(VirtualKeyCode::P),
                settings: KeyMouse::Key(VirtualKeyCode::N),
                help: KeyMouse::Key(VirtualKeyCode::F1),
                toggle_interface: KeyMouse::Key(VirtualKeyCode::F2),
                toggle_debug: KeyMouse::Key(VirtualKeyCode::F3),
                fullscreen: KeyMouse::Key(VirtualKeyCode::F11),
                screenshot: KeyMouse::Key(VirtualKeyCode::F4),
                toggle_ingame_ui: VirtualKeyCode::F6,
                pan_sensitivity: 1.0,
                zoom_sensitivity: 1.0,
                attack: KeyMouse::Mouse(MouseButton::Left),
            },
            networking: NetworkingSettings {
                username: "Username".to_string(),
                servers: vec!["server.veloren.net".to_string()],
                default_server: 0,
            },
            log: Log {
                file: "voxygen.log".into(),
            },
            graphics: GraphicsSettings { view_distance: 5 },
            audio: AudioSettings {
                music_volume: 0.5,
                sfx_volume: 0.5,
                audio_device: None,
            },
        }
    }
}

impl Settings {
    pub fn load() -> Self {
        let default_settings = Settings::default();

        let path = Settings::get_settings_path();

        let mut config = Config::new();

        config
            .merge(
                Config::try_from(&default_settings)
                    .expect("Default settings struct could not be converted to Config!"),
            )
            .unwrap();

        // TODO: Log errors here.
        // If merge or try_into fail, use the default settings.
        match config.merge::<config::File<_>>(path.into()) {
            Ok(_) => match config.try_into() {
                Ok(settings) => settings,
                Err(_) => default_settings,
            },
            Err(_) => {
                // Maybe the file didn't exist.
                // TODO: Handle this result.
                default_settings.save_to_file();
                default_settings
            }
        }
    }

    pub fn save_to_file(&self) -> std::io::Result<()> {
        let path = Settings::get_settings_path();

        if let Some(dir) = path.parent() {
            fs::create_dir_all(dir)?;
        }

        let mut config_file = fs::File::create(path)?;
        let s: &str = &toml::to_string_pretty(self).unwrap();
        config_file.write_all(s.as_bytes()).unwrap();
        Ok(())
    }

    fn get_settings_path() -> PathBuf {
        let proj_dirs =
            ProjectDirs::from("net", "veloren", "voxygen").expect("No home directory defined!");
        let path = proj_dirs.config_dir();
        path.join("settings");
        let path = path.with_extension("toml");
        path
    }
}