Extract common/src/assets.rs to own crate

This gives us ability to use assets-related code in i18n without
depending on whole veloren-common
This commit is contained in:
juliancoffee 2021-05-07 14:24:37 +03:00
parent 0784c2a76a
commit 735e8ab4ec
18 changed files with 279 additions and 409 deletions

20
Cargo.lock generated
View File

@ -5514,7 +5514,6 @@ name = "veloren-common"
version = "0.9.0" version = "0.9.0"
dependencies = [ dependencies = [
"approx 0.4.0", "approx 0.4.0",
"assets_manager",
"bitflags", "bitflags",
"criterion", "criterion",
"crossbeam-channel", "crossbeam-channel",
@ -5523,7 +5522,6 @@ dependencies = [
"dot_vox", "dot_vox",
"enum-iterator", "enum-iterator",
"hashbrown", "hashbrown",
"image",
"indexmap", "indexmap",
"lazy_static", "lazy_static",
"num-derive", "num-derive",
@ -5531,10 +5529,8 @@ dependencies = [
"ordered-float 2.1.1", "ordered-float 2.1.1",
"rand 0.8.3", "rand 0.8.3",
"rayon", "rayon",
"ron",
"roots", "roots",
"serde", "serde",
"serde_json",
"serde_repr", "serde_repr",
"slab", "slab",
"slotmap", "slotmap",
@ -5548,9 +5544,22 @@ dependencies = [
"tracing-subscriber", "tracing-subscriber",
"uuid", "uuid",
"vek", "vek",
"veloren-common-assets",
"veloren-common-base", "veloren-common-base",
] ]
[[package]]
name = "veloren-common-assets"
version = "0.9.0"
dependencies = [
"assets_manager",
"dot_vox",
"image",
"lazy_static",
"ron",
"tracing",
]
[[package]] [[package]]
name = "veloren-common-base" name = "veloren-common-base"
version = "0.9.0" version = "0.9.0"
@ -5647,14 +5656,13 @@ dependencies = [
name = "veloren-i18n" name = "veloren-i18n"
version = "0.9.0" version = "0.9.0"
dependencies = [ dependencies = [
"assets_manager",
"deunicode", "deunicode",
"git2", "git2",
"hashbrown", "hashbrown",
"lazy_static",
"ron", "ron",
"serde", "serde",
"tracing", "tracing",
"veloren-common-assets",
] ]
[[package]] [[package]]

View File

@ -3,6 +3,7 @@ cargo-features = ["named-profiles","profile-overrides"]
[workspace] [workspace]
members = [ members = [
"common", "common",
"common/assets",
"common/base", "common/base",
"common/ecs", "common/ecs",
"common/net", "common/net",

View File

@ -39,14 +39,10 @@ uuid = { version = "0.8.1", default-features = false, features = ["serde", "v4"]
rand = "0.8" rand = "0.8"
# Assets # Assets
assets = {package = "veloren-common-assets", path = "assets"}
dot_vox = "4.0" dot_vox = "4.0"
image = { version = "0.23.12", default-features = false, features = ["png"] }
# Assets # Assets
assets_manager = {version = "0.4.2", features = ["bincode", "ron", "json", "hot-reloading"]}
# Serde
ron = { version = "0.6", default-features = false }
serde_json = "1.0.50"
serde_repr = "0.1.6" serde_repr = "0.1.6"
# csv export # csv export

14
common/assets/Cargo.toml Normal file
View File

@ -0,0 +1,14 @@
[package]
authors = ["juliancoffee <lightdarkdaughter@gmail.com>"]
edition = "2018"
name = "veloren-common-assets"
description = "Crate for game loading assets for veloren."
version = "0.9.0"
[dependencies]
lazy_static = "1.4.0"
assets_manager = {version = "0.4.2", features = ["bincode", "ron", "json", "hot-reloading"]}
ron = { version = "0.6", default-features = false }
dot_vox = "4.0"
image = { version = "0.23.12", default-features = false, features = ["png"] }
tracing = "0.1"

View File

@ -1,12 +1,21 @@
//! Load assets (images or voxel data) from files //! Load assets (images or voxel data) from files
use dot_vox::DotVoxData;
use image::DynamicImage;
use lazy_static::lazy_static; use lazy_static::lazy_static;
use std::path::PathBuf; use std::{
borrow::Cow,
fs, io,
path::{Path, PathBuf},
sync::Arc,
};
pub use assets_manager::{ pub use assets_manager::{
asset::Ron, asset::Ron,
loader::{self, RonLoader}, loader::{
source, Asset, AssetCache, Compound, Error, self, BincodeLoader, BytesLoader, JsonLoader, LoadFrom, Loader, RonLoader, StringLoader,
},
source, Asset, AssetCache, BoxedError, Compound, Error,
}; };
lazy_static! { lazy_static! {
@ -14,13 +23,22 @@ lazy_static! {
static ref ASSETS: AssetCache = AssetCache::new(&*ASSETS_PATH).unwrap(); static ref ASSETS: AssetCache = AssetCache::new(&*ASSETS_PATH).unwrap();
} }
pub fn start_hot_reloading() { ASSETS.enhance_hot_reloading(); }
pub type AssetHandle<T> = assets_manager::Handle<'static, T>; pub type AssetHandle<T> = assets_manager::Handle<'static, T>;
pub type AssetGuard<T> = assets_manager::AssetGuard<'static, T>; pub type AssetGuard<T> = assets_manager::AssetGuard<'static, T>;
pub type AssetDir<T> = assets_manager::DirReader<'static, T, source::FileSystem>;
/// The Asset trait, which is implemented by all structures that have their data /// The Asset trait, which is implemented by all structures that have their data
/// stored in the filesystem. /// stored in the filesystem.
pub trait AssetExt: Sized + Send + Sync + 'static { pub trait AssetExt: Sized + Send + Sync + 'static {
/// Function used to load assets from the filesystem or the cache. /// Function used to load assets from the filesystem or the cache.
/// Example usage:
/// ```no_run
/// use veloren_common::assets::{self, AssetExt};
///
/// let my_image = assets::Image::load("core.ui.backgrounds.city").unwrap();
/// ```
fn load(specifier: &str) -> Result<AssetHandle<Self>, Error>; fn load(specifier: &str) -> Result<AssetHandle<Self>, Error>;
/// Function used to load assets from the filesystem or the cache and return /// Function used to load assets from the filesystem or the cache and return
@ -33,7 +51,12 @@ pub trait AssetExt: Sized + Send + Sync + 'static {
} }
/// Function used to load essential assets from the filesystem or the cache. /// Function used to load essential assets from the filesystem or the cache.
/// It will panic if the asset is not found. /// It will panic if the asset is not found. Example usage:
/// ```no_run
/// use veloren_common::assets::{self, AssetExt};
///
/// let my_image = assets::Image::load_expect("core.ui.backgrounds.city");
/// ```
#[track_caller] #[track_caller]
fn load_expect(specifier: &str) -> AssetHandle<Self> { fn load_expect(specifier: &str) -> AssetHandle<Self> {
Self::load(specifier).unwrap_or_else(|err| { Self::load(specifier).unwrap_or_else(|err| {
@ -57,12 +80,52 @@ pub trait AssetExt: Sized + Send + Sync + 'static {
fn load_owned(specifier: &str) -> Result<Self, Error>; fn load_owned(specifier: &str) -> Result<Self, Error>;
} }
pub fn load_dir<T: Asset>(specifier: &str) -> Result<AssetDir<T>, Error> {
Ok(ASSETS.load_dir(specifier)?)
}
impl<T: Compound> AssetExt for T { impl<T: Compound> AssetExt for T {
fn load(specifier: &str) -> Result<AssetHandle<Self>, Error> { ASSETS.load(specifier) } fn load(specifier: &str) -> Result<AssetHandle<Self>, Error> { ASSETS.load(specifier) }
fn load_owned(specifier: &str) -> Result<Self, Error> { ASSETS.load_owned(specifier) } fn load_owned(specifier: &str) -> Result<Self, Error> { ASSETS.load_owned(specifier) }
} }
pub struct Image(pub Arc<DynamicImage>);
impl Image {
pub fn to_image(&self) -> Arc<DynamicImage> { Arc::clone(&self.0) }
}
pub struct ImageLoader;
impl Loader<Image> for ImageLoader {
fn load(content: Cow<[u8]>, _: &str) -> Result<Image, BoxedError> {
let image = image::load_from_memory(&content)?;
Ok(Image(Arc::new(image)))
}
}
impl Asset for Image {
type Loader = ImageLoader;
const EXTENSIONS: &'static [&'static str] = &["png", "jpg"];
}
pub struct DotVoxAsset(pub DotVoxData);
pub struct DotVoxLoader;
impl Loader<DotVoxAsset> for DotVoxLoader {
fn load(content: std::borrow::Cow<[u8]>, _: &str) -> Result<DotVoxAsset, BoxedError> {
let data = dot_vox::load_bytes(&content).map_err(|err| err.to_owned())?;
Ok(DotVoxAsset(data))
}
}
impl Asset for DotVoxAsset {
type Loader = DotVoxLoader;
const EXTENSION: &'static str = "vox";
}
lazy_static! { lazy_static! {
/// Lazy static to find and cache where the asset directory is. /// Lazy static to find and cache where the asset directory is.
/// Cases we need to account for: /// Cases we need to account for:
@ -147,3 +210,40 @@ lazy_static! {
/// ///
/// For directories, give `""` as extension. /// For directories, give `""` as extension.
pub fn path_of(specifier: &str, ext: &str) -> PathBuf { ASSETS.source().path_of(specifier, ext) } pub fn path_of(specifier: &str, ext: &str) -> PathBuf { ASSETS.source().path_of(specifier, ext) }
fn get_dir_files(files: &mut Vec<String>, path: &Path, specifier: &str) -> io::Result<()> {
for entry in (fs::read_dir(path)?).flatten() {
let path = entry.path();
let maybe_stem = path.file_stem().and_then(|stem| stem.to_str());
if let Some(stem) = maybe_stem {
let specifier = format!("{}.{}", specifier, stem);
if path.is_dir() {
get_dir_files(files, &path, &specifier)?;
} else {
files.push(specifier);
}
}
}
Ok(())
}
pub struct Directory(Vec<String>);
impl Directory {
pub fn iter(&self) -> impl Iterator<Item = &String> { self.0.iter() }
}
impl Compound for Directory {
fn load<S: source::Source>(_: &AssetCache<S>, specifier: &str) -> Result<Self, Error> {
let specifier = specifier.strip_suffix(".*").unwrap_or(specifier);
let root = ASSETS.source().path_of(specifier, "");
let mut files = Vec::new();
get_dir_files(&mut files, &root, specifier)?;
Ok(Directory(files))
}
}

View File

@ -1,358 +0,0 @@
//! Load assets (images or voxel data) from files
use dot_vox::DotVoxData;
use image::DynamicImage;
use lazy_static::lazy_static;
use std::{
borrow::Cow,
fs, io,
path::{Path, PathBuf},
sync::Arc,
};
pub use assets_manager::{
asset::Ron,
loader::{
self, BincodeLoader, BytesLoader, JsonLoader, LoadFrom, Loader, RonLoader, StringLoader,
},
source, Asset, AssetCache, BoxedError, Compound, Error,
};
lazy_static! {
/// The HashMap where all loaded assets are stored in.
static ref ASSETS: AssetCache = AssetCache::new(&*ASSETS_PATH).unwrap();
}
pub fn start_hot_reloading() { ASSETS.enhance_hot_reloading(); }
pub type AssetHandle<T> = assets_manager::Handle<'static, T>;
pub type AssetGuard<T> = assets_manager::AssetGuard<'static, T>;
pub type AssetDir<T> = assets_manager::DirReader<'static, T, source::FileSystem>;
/// The Asset trait, which is implemented by all structures that have their data
/// stored in the filesystem.
pub trait AssetExt: Sized + Send + Sync + 'static {
/// Function used to load assets from the filesystem or the cache.
/// Example usage:
/// ```no_run
/// use veloren_common::assets::{self, AssetExt};
///
/// let my_image = assets::Image::load("core.ui.backgrounds.city").unwrap();
/// ```
fn load(specifier: &str) -> Result<AssetHandle<Self>, Error>;
/// Function used to load assets from the filesystem or the cache and return
/// a clone.
fn load_cloned(specifier: &str) -> Result<Self, Error>
where
Self: Clone,
{
Self::load(specifier).map(AssetHandle::cloned)
}
/// Function used to load essential assets from the filesystem or the cache.
/// It will panic if the asset is not found. Example usage:
/// ```no_run
/// use veloren_common::assets::{self, AssetExt};
///
/// let my_image = assets::Image::load_expect("core.ui.backgrounds.city");
/// ```
#[track_caller]
fn load_expect(specifier: &str) -> AssetHandle<Self> {
Self::load(specifier).unwrap_or_else(|err| {
panic!(
"Failed loading essential asset: {} (error={:?})",
specifier, err
)
})
}
/// Function used to load essential assets from the filesystem or the cache
/// and return a clone. It will panic if the asset is not found.
#[track_caller]
fn load_expect_cloned(specifier: &str) -> Self
where
Self: Clone,
{
Self::load_expect(specifier).cloned()
}
fn load_owned(specifier: &str) -> Result<Self, Error>;
}
pub fn load_dir<T: Asset>(specifier: &str) -> Result<AssetDir<T>, Error> {
Ok(ASSETS.load_dir(specifier)?)
}
impl<T: Compound> AssetExt for T {
fn load(specifier: &str) -> Result<AssetHandle<Self>, Error> { ASSETS.load(specifier) }
fn load_owned(specifier: &str) -> Result<Self, Error> { ASSETS.load_owned(specifier) }
}
pub struct Image(pub Arc<DynamicImage>);
impl Image {
pub fn to_image(&self) -> Arc<DynamicImage> { Arc::clone(&self.0) }
}
pub struct ImageLoader;
impl Loader<Image> for ImageLoader {
fn load(content: Cow<[u8]>, _: &str) -> Result<Image, BoxedError> {
let image = image::load_from_memory(&content)?;
Ok(Image(Arc::new(image)))
}
}
impl Asset for Image {
type Loader = ImageLoader;
const EXTENSIONS: &'static [&'static str] = &["png", "jpg"];
}
pub struct DotVoxAsset(pub DotVoxData);
pub struct DotVoxLoader;
impl Loader<DotVoxAsset> for DotVoxLoader {
fn load(content: std::borrow::Cow<[u8]>, _: &str) -> Result<DotVoxAsset, BoxedError> {
let data = dot_vox::load_bytes(&content).map_err(|err| err.to_owned())?;
Ok(DotVoxAsset(data))
}
}
impl Asset for DotVoxAsset {
type Loader = DotVoxLoader;
const EXTENSION: &'static str = "vox";
}
lazy_static! {
/// Lazy static to find and cache where the asset directory is.
/// Cases we need to account for:
/// 1. Running through airshipper (`assets` next to binary)
/// 2. Install with package manager and run (assets probably in `/usr/share/veloren/assets` while binary in `/usr/bin/`)
/// 3. Download & hopefully extract zip (`assets` next to binary)
/// 4. Running through cargo (`assets` in workspace root but not always in cwd incase you `cd voxygen && cargo r`)
/// 5. Running executable in the target dir (`assets` in workspace)
pub static ref ASSETS_PATH: PathBuf = {
let mut paths = Vec::new();
// Note: Ordering matters here!
// 1. VELOREN_ASSETS environment variable
if let Ok(var) = std::env::var("VELOREN_ASSETS") {
paths.push(var.into());
}
// 2. Executable path
if let Ok(mut path) = std::env::current_exe() {
path.pop();
paths.push(path);
}
// 3. Working path
if let Ok(path) = std::env::current_dir() {
paths.push(path);
}
// 4. Cargo Workspace (e.g. local development)
// https://github.com/rust-lang/cargo/issues/3946#issuecomment-359619839
if let Ok(Ok(path)) = std::env::var("CARGO_MANIFEST_DIR").map(|s| s.parse::<PathBuf>()) {
paths.push(path.parent().unwrap().to_path_buf());
paths.push(path);
}
// 5. System paths
#[cfg(all(unix, not(target_os = "macos"), not(target_os = "ios"), not(target_os = "android")))]
{
if let Ok(result) = std::env::var("XDG_DATA_HOME") {
paths.push(format!("{}/veloren/", result).into());
} else if let Ok(result) = std::env::var("HOME") {
paths.push(format!("{}/.local/share/veloren/", result).into());
}
if let Ok(result) = std::env::var("XDG_DATA_DIRS") {
result.split(':').for_each(|x| paths.push(format!("{}/veloren/", x).into()));
} else {
// Fallback
let fallback_paths = vec!["/usr/local/share", "/usr/share"];
for fallback_path in fallback_paths {
paths.push(format!("{}/veloren/", fallback_path).into());
}
}
}
tracing::trace!("Possible asset locations paths={:?}", paths);
for mut path in paths.clone() {
if !path.ends_with("assets") {
path = path.join("assets");
}
if path.is_dir() {
tracing::info!("Assets found path={}", path.display());
return path;
}
}
panic!(
"Asset directory not found. In attempting to find it, we searched:\n{})",
paths.iter().fold(String::new(), |mut a, path| {
a += &path.to_string_lossy();
a += "\n";
a
}),
);
};
}
/// Returns the actual path of the specifier with the extension.
///
/// For directories, give `""` as extension.
pub fn path_of(specifier: &str, ext: &str) -> PathBuf { ASSETS.source().path_of(specifier, ext) }
fn get_dir_files(files: &mut Vec<String>, path: &Path, specifier: &str) -> io::Result<()> {
for entry in (fs::read_dir(path)?).flatten() {
let path = entry.path();
let maybe_stem = path.file_stem().and_then(|stem| stem.to_str());
if let Some(stem) = maybe_stem {
let specifier = format!("{}.{}", specifier, stem);
if path.is_dir() {
get_dir_files(files, &path, &specifier)?;
} else {
files.push(specifier);
}
}
}
Ok(())
}
pub struct Directory(Vec<String>);
impl Directory {
pub fn iter(&self) -> impl Iterator<Item = &String> { self.0.iter() }
}
impl Compound for Directory {
fn load<S: source::Source>(_: &AssetCache<S>, specifier: &str) -> Result<Self, Error> {
let specifier = specifier.strip_suffix(".*").unwrap_or(specifier);
let root = ASSETS.source().path_of(specifier, "");
let mut files = Vec::new();
get_dir_files(&mut files, &root, specifier)?;
Ok(Directory(files))
}
}
#[cfg(test)]
mod tests {
#[test]
fn test_assets_items() {
// TODO: Figure out how to get file name in error so only a single glob is
// needed
// Separated out into subsections so that error more descriptive
crate::comp::item::Item::new_from_asset_glob("common.items.armor.*")
.expect("Failed to iterate over armors.");
crate::comp::item::Item::new_from_asset_glob("common.items.boss_drops.*")
.expect("Failed to iterate over boss drops.");
crate::comp::item::Item::new_from_asset_glob("common.items.consumable.*")
.expect("Failed to iterate over consumables.");
crate::comp::item::Item::new_from_asset_glob("common.items.crafting_ing.*")
.expect("Failed to iterate over crafting ingredients.");
crate::comp::item::Item::new_from_asset_glob("common.items.crafting_tools.*")
.expect("Failed to iterate over crafting tools.");
crate::comp::item::Item::new_from_asset_glob("common.items.debug.*")
.expect("Failed to iterate over debug items.");
crate::comp::item::Item::new_from_asset_glob("common.items.flowers.*")
.expect("Failed to iterate over flower items.");
crate::comp::item::Item::new_from_asset_glob("common.items.food.*")
.expect("Failed to iterate over food items.");
crate::comp::item::Item::new_from_asset_glob("common.items.glider.*")
.expect("Failed to iterate over gliders.");
crate::comp::item::Item::new_from_asset_glob("common.items.grasses.*")
.expect("Failed to iterate over grasses.");
crate::comp::item::Item::new_from_asset_glob("common.items.lantern.*")
.expect("Failed to iterate over lanterns.");
crate::comp::item::Item::new_from_asset_glob("common.items.npc_armor.*")
.expect("Failed to iterate over npc armors.");
crate::comp::item::Item::new_from_asset_glob("common.items.npc_weapons.*")
.expect("Failed to iterate over npc weapons.");
crate::comp::item::Item::new_from_asset_glob("common.items.ore.*")
.expect("Failed to iterate over ores.");
crate::comp::item::Item::new_from_asset_glob("common.items.tag_examples.*")
.expect("Failed to iterate over tag examples.");
crate::comp::item::Item::new_from_asset_glob("common.items.testing.*")
.expect("Failed to iterate over testing items.");
crate::comp::item::Item::new_from_asset_glob("common.items.utility.*")
.expect("Failed to iterate over utility items.");
// Checks each weapon type to allow errors to be located more easily
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.axe.*")
.expect("Failed to iterate over axes.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.axe_1h.*")
.expect("Failed to iterate over 1h axes.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.bow.*")
.expect("Failed to iterate over bows.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.dagger.*")
.expect("Failed to iterate over daggers.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.empty.*")
.expect("Failed to iterate over empty.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.hammer.*")
.expect("Failed to iterate over hammers.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.hammer_1h.*")
.expect("Failed to iterate over 1h hammers.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.sceptre.*")
.expect("Failed to iterate over sceptres.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.shield.*")
.expect("Failed to iterate over shields.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.staff.*")
.expect("Failed to iterate over staffs.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.sword.*")
.expect("Failed to iterate over swords.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.sword_1h.*")
.expect("Failed to iterate over 1h swords.");
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.tool.*")
.expect("Failed to iterate over tools.");
// Checks all weapons should more weapons be added later
crate::comp::item::Item::new_from_asset_glob("common.items.weapons.*")
.expect("Failed to iterate over weapons.");
// Final at the end to account for a new folder being added
crate::comp::item::Item::new_from_asset_glob("common.items.*")
.expect("Failed to iterate over item folders.");
}
}

View File

@ -407,8 +407,8 @@ impl Deref for Item {
} }
impl assets::Compound for ItemDef { impl assets::Compound for ItemDef {
fn load<S: assets_manager::source::Source>( fn load<S: assets::source::Source>(
cache: &assets_manager::AssetCache<S>, cache: &assets::AssetCache<S>,
specifier: &str, specifier: &str,
) -> Result<Self, Error> { ) -> Result<Self, Error> {
// load from the filesystem first, but if the file doesn't exist, see if it's a // load from the filesystem first, but if the file doesn't exist, see if it's a
@ -853,3 +853,111 @@ impl<'a, T: ItemDesc + ?Sized> ItemDesc for &'a T {
fn tags(&self) -> &[ItemTag] { (*self).tags() } fn tags(&self) -> &[ItemTag] { (*self).tags() }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_assets_items() {
// TODO: Figure out how to get file name in error so only a single glob is
// needed
// Separated out into subsections so that error more descriptive
Item::new_from_asset_glob("common.items.armor.*").expect("Failed to iterate over armors.");
Item::new_from_asset_glob("common.items.boss_drops.*")
.expect("Failed to iterate over boss drops.");
Item::new_from_asset_glob("common.items.consumable.*")
.expect("Failed to iterate over consumables.");
Item::new_from_asset_glob("common.items.crafting_ing.*")
.expect("Failed to iterate over crafting ingredients.");
Item::new_from_asset_glob("common.items.crafting_tools.*")
.expect("Failed to iterate over crafting tools.");
Item::new_from_asset_glob("common.items.debug.*")
.expect("Failed to iterate over debug items.");
Item::new_from_asset_glob("common.items.flowers.*")
.expect("Failed to iterate over flower items.");
Item::new_from_asset_glob("common.items.food.*")
.expect("Failed to iterate over food items.");
Item::new_from_asset_glob("common.items.glider.*")
.expect("Failed to iterate over gliders.");
Item::new_from_asset_glob("common.items.grasses.*")
.expect("Failed to iterate over grasses.");
Item::new_from_asset_glob("common.items.lantern.*")
.expect("Failed to iterate over lanterns.");
Item::new_from_asset_glob("common.items.npc_armor.*")
.expect("Failed to iterate over npc armors.");
Item::new_from_asset_glob("common.items.npc_weapons.*")
.expect("Failed to iterate over npc weapons.");
Item::new_from_asset_glob("common.items.ore.*").expect("Failed to iterate over ores.");
Item::new_from_asset_glob("common.items.tag_examples.*")
.expect("Failed to iterate over tag examples.");
Item::new_from_asset_glob("common.items.testing.*")
.expect("Failed to iterate over testing items.");
Item::new_from_asset_glob("common.items.utility.*")
.expect("Failed to iterate over utility items.");
// Checks each weapon type to allow errors to be located more easily
Item::new_from_asset_glob("common.items.weapons.axe.*")
.expect("Failed to iterate over axes.");
Item::new_from_asset_glob("common.items.weapons.axe_1h.*")
.expect("Failed to iterate over 1h axes.");
Item::new_from_asset_glob("common.items.weapons.bow.*")
.expect("Failed to iterate over bows.");
Item::new_from_asset_glob("common.items.weapons.dagger.*")
.expect("Failed to iterate over daggers.");
Item::new_from_asset_glob("common.items.weapons.empty.*")
.expect("Failed to iterate over empty.");
Item::new_from_asset_glob("common.items.weapons.hammer.*")
.expect("Failed to iterate over hammers.");
Item::new_from_asset_glob("common.items.weapons.hammer_1h.*")
.expect("Failed to iterate over 1h hammers.");
Item::new_from_asset_glob("common.items.weapons.sceptre.*")
.expect("Failed to iterate over sceptres.");
Item::new_from_asset_glob("common.items.weapons.shield.*")
.expect("Failed to iterate over shields.");
Item::new_from_asset_glob("common.items.weapons.staff.*")
.expect("Failed to iterate over staffs.");
Item::new_from_asset_glob("common.items.weapons.sword.*")
.expect("Failed to iterate over swords.");
Item::new_from_asset_glob("common.items.weapons.sword_1h.*")
.expect("Failed to iterate over 1h swords.");
Item::new_from_asset_glob("common.items.weapons.tool.*")
.expect("Failed to iterate over tools.");
// Checks all weapons should more weapons be added later
Item::new_from_asset_glob("common.items.weapons.*")
.expect("Failed to iterate over weapons.");
// Final at the end to account for a new folder being added
Item::new_from_asset_glob("common.items.*").expect("Failed to iterate over item folders.");
}
}

View File

@ -392,8 +392,8 @@ impl Asset for AbilityMap<String> {
} }
impl assets::Compound for AbilityMap { impl assets::Compound for AbilityMap {
fn load<S: assets_manager::source::Source>( fn load<S: assets::source::Source>(
cache: &assets_manager::AssetCache<S>, cache: &assets::AssetCache<S>,
specifier: &str, specifier: &str,
) -> Result<Self, assets::Error> { ) -> Result<Self, assets::Error> {
let manifest = cache.load::<AbilityMap<String>>(specifier)?.read(); let manifest = cache.load::<AbilityMap<String>>(specifier)?.read();

View File

@ -4,7 +4,7 @@ use crate::{
recipe::{default_recipe_book, RecipeInput}, recipe::{default_recipe_book, RecipeInput},
trade::Good, trade::Good,
}; };
use assets_manager::AssetGuard; use assets::AssetGuard;
use hashbrown::HashMap; use hashbrown::HashMap;
use lazy_static::lazy_static; use lazy_static::lazy_static;
use serde::Deserialize; use serde::Deserialize;

View File

@ -23,7 +23,7 @@ pub use uuid;
// modules // modules
#[cfg(not(target_arch = "wasm32"))] #[cfg(not(target_arch = "wasm32"))]
pub mod assets; pub use assets;
#[cfg(not(target_arch = "wasm32"))] pub mod astar; #[cfg(not(target_arch = "wasm32"))] pub mod astar;
#[cfg(not(target_arch = "wasm32"))] #[cfg(not(target_arch = "wasm32"))]
mod cached_spatial_grid; mod cached_spatial_grid;

View File

@ -108,10 +108,10 @@ impl assets::Asset for RawRecipeBook {
} }
impl assets::Compound for RecipeBook { impl assets::Compound for RecipeBook {
fn load<S: assets_manager::source::Source>( fn load<S: assets::source::Source>(
cache: &assets_manager::AssetCache<S>, cache: &assets::AssetCache<S>,
specifier: &str, specifier: &str,
) -> Result<Self, assets_manager::Error> { ) -> Result<Self, assets::Error> {
#[inline] #[inline]
fn load_item_def(spec: &(String, u32)) -> Result<(Arc<ItemDef>, u32), assets::Error> { fn load_item_def(spec: &(String, u32)) -> Result<(Arc<ItemDef>, u32), assets::Error> {
let def = Arc::<ItemDef>::load_cloned(&spec.0)?; let def = Arc::<ItemDef>::load_cloned(&spec.0)?;

View File

@ -60,8 +60,8 @@ impl std::ops::Deref for StructuresGroup {
} }
impl assets::Compound for StructuresGroup { impl assets::Compound for StructuresGroup {
fn load<S: assets_manager::source::Source>( fn load<S: assets::source::Source>(
cache: &assets_manager::AssetCache<S>, cache: &assets::AssetCache<S>,
specifier: &str, specifier: &str,
) -> Result<Self, Error> { ) -> Result<Self, Error> {
let specs = cache.load::<StructuresGroupSpec>(specifier)?.read(); let specs = cache.load::<StructuresGroupSpec>(specifier)?.read();
@ -118,8 +118,8 @@ impl ReadVol for Structure {
} }
impl assets::Compound for BaseStructure { impl assets::Compound for BaseStructure {
fn load<S: assets_manager::source::Source>( fn load<S: assets::source::Source>(
cache: &assets_manager::AssetCache<S>, cache: &assets::AssetCache<S>,
specifier: &str, specifier: &str,
) -> Result<Self, Error> { ) -> Result<Self, Error> {
let dot_vox_data = cache.load::<DotVoxAsset>(specifier)?.read(); let dot_vox_data = cache.load::<DotVoxAsset>(specifier)?.read();

View File

@ -9,12 +9,13 @@ version = "0.9.0"
name = "i18n-check" name = "i18n-check"
[dependencies] [dependencies]
lazy_static = "1.4.0" # Assets
hashbrown = { version = "0.9", features = ["serde", "nightly"] } hashbrown = { version = "0.9", features = ["serde", "nightly"] }
assets_manager = {version = "0.4.2", features = ["bincode", "ron", "json", "hot-reloading"]} common-assets = {package = "veloren-common-assets", path = "../../common/assets"}
deunicode = "1.0" deunicode = "1.0"
ron = "0.6"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
tracing = "0.1"
# Diagnostic # Diagnostic
git2 = "0.13" git2 = "0.13"
ron = "0.6"
tracing = "0.1"

View File

@ -172,7 +172,9 @@ impl assets::Compound for Language {
asset_key: &str, asset_key: &str,
) -> Result<Self, assets::Error> { ) -> Result<Self, assets::Error> {
let raw = cache let raw = cache
.load::<RawLocalization>(&[asset_key, ".", LANG_MANIFEST_FILE].concat())? .load::<RawLocalization>(
&["voxygen.i18n.", asset_key, ".", LANG_MANIFEST_FILE].concat(),
)?
.cloned(); .cloned();
let mut localization = Language::from(raw); let mut localization = Language::from(raw);
@ -333,7 +335,7 @@ impl LocalizationHandle {
} }
pub fn load(specifier: &str) -> Result<Self, crate::assets::Error> { pub fn load(specifier: &str) -> Result<Self, crate::assets::Error> {
let default_key = i18n_asset_key(REFERENCE_LANG); let default_key = REFERENCE_LANG;
let is_default = specifier == default_key; let is_default = specifier == default_key;
Ok(Self { Ok(Self {
active: Language::load(specifier)?, active: Language::load(specifier)?,
@ -381,12 +383,10 @@ impl assets::Compound for LocalizationList {
} }
/// Load all the available languages located in the voxygen asset directory /// Load all the available languages located in the voxygen asset directory
pub fn list_localizations() -> Vec<LanguageMetadata> { pub fn list_localizations() -> Vec<LanguageMetadata> { LocalizationList::load_expect_cloned("").0 }
LocalizationList::load_expect_cloned("voxygen.i18n").0
}
/// Return the asset associated with the language_id /// Start hot reloading of i18n assets
pub fn i18n_asset_key(language_id: &str) -> String { ["voxygen.i18n.", language_id].concat() } pub fn start_hot_reloading() { assets::start_hot_reloading(); }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {

View File

@ -1,5 +1,5 @@
pub mod analysis; pub mod analysis;
mod assets;
mod i18n; mod i18n;
use common_assets as assets;
pub use i18n::*; pub use i18n::*;

View File

@ -5,7 +5,7 @@
use veloren_voxygen::{ use veloren_voxygen::{
audio::AudioFrontend, audio::AudioFrontend,
i18n::{self, i18n_asset_key, LocalizationHandle}, i18n::{self, LocalizationHandle},
profile::Profile, profile::Profile,
run, run,
scene::terrain::SpriteRenderContext, scene::terrain::SpriteRenderContext,
@ -144,6 +144,7 @@ fn main() {
})); }));
assets::start_hot_reloading(); assets::start_hot_reloading();
i18n::start_hot_reloading();
// Initialise watcher for animation hotreloading // Initialise watcher for animation hotreloading
#[cfg(feature = "hot-anim")] #[cfg(feature = "hot-anim")]
@ -163,8 +164,8 @@ fn main() {
// Load the profile. // Load the profile.
let profile = Profile::load(); let profile = Profile::load();
let mut i18n = LocalizationHandle::load(&i18n_asset_key(&settings.language.selected_language)) let mut i18n =
.unwrap_or_else(|error| { LocalizationHandle::load(&settings.language.selected_language).unwrap_or_else(|error| {
let selected_language = &settings.language.selected_language; let selected_language = &settings.language.selected_language;
warn!( warn!(
?error, ?error,
@ -172,7 +173,7 @@ fn main() {
"Impossible to load language: change to the default language (English) instead.", "Impossible to load language: change to the default language (English) instead.",
); );
settings.language.selected_language = i18n::REFERENCE_LANG.to_owned(); settings.language.selected_language = i18n::REFERENCE_LANG.to_owned();
LocalizationHandle::load_expect(&i18n_asset_key(&settings.language.selected_language)) LocalizationHandle::load_expect(&settings.language.selected_language)
}); });
i18n.read().log_missing_entries(); i18n.read().log_missing_entries();
i18n.set_english_fallback(settings.language.use_english_fallback); i18n.set_english_fallback(settings.language.use_english_fallback);

View File

@ -5,7 +5,7 @@ use super::char_selection::CharSelectionState;
#[cfg(feature = "singleplayer")] #[cfg(feature = "singleplayer")]
use crate::singleplayer::Singleplayer; use crate::singleplayer::Singleplayer;
use crate::{ use crate::{
i18n::{i18n_asset_key, Localization, LocalizationHandle}, i18n::{Localization, LocalizationHandle},
render::Renderer, render::Renderer,
settings::Settings, settings::Settings,
window::Event, window::Event,
@ -295,9 +295,9 @@ impl PlayState for MainMenuState {
MainMenuEvent::ChangeLanguage(new_language) => { MainMenuEvent::ChangeLanguage(new_language) => {
global_state.settings.language.selected_language = global_state.settings.language.selected_language =
new_language.language_identifier; new_language.language_identifier;
global_state.i18n = LocalizationHandle::load_expect(&i18n_asset_key( global_state.i18n = LocalizationHandle::load_expect(
&global_state.settings.language.selected_language, &global_state.settings.language.selected_language,
)); );
global_state.i18n.read().log_missing_entries(); global_state.i18n.read().log_missing_entries();
global_state global_state
.i18n .i18n

View File

@ -5,7 +5,7 @@ use crate::{
BarNumbers, BuffPosition, CrosshairType, Intro, PressBehavior, ScaleChange, BarNumbers, BuffPosition, CrosshairType, Intro, PressBehavior, ScaleChange,
ShortcutNumbers, XpBar, ShortcutNumbers, XpBar,
}, },
i18n::{i18n_asset_key, LanguageMetadata, LocalizationHandle}, i18n::{LanguageMetadata, LocalizationHandle},
render::RenderMode, render::RenderMode,
settings::{ settings::{
AudioSettings, ControlSettings, Fps, GamepadSettings, GameplaySettings, GraphicsSettings, AudioSettings, ControlSettings, Fps, GamepadSettings, GameplaySettings, GraphicsSettings,
@ -482,9 +482,8 @@ impl SettingsChange {
SettingsChange::Language(language_change) => match language_change { SettingsChange::Language(language_change) => match language_change {
Language::ChangeLanguage(new_language) => { Language::ChangeLanguage(new_language) => {
settings.language.selected_language = new_language.language_identifier; settings.language.selected_language = new_language.language_identifier;
global_state.i18n = LocalizationHandle::load_expect(&i18n_asset_key( global_state.i18n =
&settings.language.selected_language, LocalizationHandle::load_expect(&settings.language.selected_language);
));
global_state.i18n.read().log_missing_entries(); global_state.i18n.read().log_missing_entries();
global_state global_state
.i18n .i18n