From 065654f451284e219c6d3399c365d1205a7cbc4f Mon Sep 17 00:00:00 2001 From: Imbris Date: Fri, 24 Sep 2021 01:48:29 -0400 Subject: [PATCH 1/4] Add basic credits screen to the main menu with some example data loaded from a ron file --- assets/common/credits.ron | 23 ++++ assets/voxygen/i18n/en/main.ron | 8 ++ voxygen/src/credits.rs | 43 ++++++ voxygen/src/lib.rs | 1 + voxygen/src/menu/main/ui/credits.rs | 195 ++++++++++++++++++++++++++++ voxygen/src/menu/main/ui/login.rs | 9 ++ voxygen/src/menu/main/ui/mod.rs | 18 +++ 7 files changed, 297 insertions(+) create mode 100644 assets/common/credits.ron create mode 100644 voxygen/src/credits.rs create mode 100644 voxygen/src/menu/main/ui/credits.rs diff --git a/assets/common/credits.ron b/assets/common/credits.ron new file mode 100644 index 0000000000..0541b3a504 --- /dev/null +++ b/assets/common/credits.ron @@ -0,0 +1,23 @@ +( + music: [( + name: "Desert jams", + authors: ["AuthorOne", "author two"], + )], + fonts: [( + name: "Wizard", + license: "cc-by-sa 3", + )], + other_art: [( + name: "Voxel shrooms", + authors: ["AuthorOne", "author two"], + )], + contributors: [ + ( + name: "Example", + contributions: "An example note", + ), + ( + name: "Example Two", + ), + ], +) diff --git a/assets/voxygen/i18n/en/main.ron b/assets/voxygen/i18n/en/main.ron index 3f48895725..650721de8d 100644 --- a/assets/voxygen/i18n/en/main.ron +++ b/assets/voxygen/i18n/en/main.ron @@ -61,6 +61,14 @@ https://veloren.net/account/."#, "main.login.client_version": "Client Version", "main.login.server_version": "Server Version", "main.servers.select_server": "Select a server", + + // Credits screen + "main.credits": "Credits", + "main.credits.music": "Music", + "main.credits.fonts": "Fonts", + "main.credits.other_art": "Other Art", + "main.credits.contributors": "Contributors", + /// End Main screen section }, diff --git a/voxygen/src/credits.rs b/voxygen/src/credits.rs new file mode 100644 index 0000000000..45bcdc215d --- /dev/null +++ b/voxygen/src/credits.rs @@ -0,0 +1,43 @@ +use common::assets; +use serde::Deserialize; + +// NOTE: we are free to split the manifest asset format and the format processed +// for display into separate structs but they happen to be identical for now + +// TODO: add serde attribs to certain fields + +#[derive(Clone, Deserialize)] +pub struct Art { + pub name: String, + // Include asset path as a field? + #[serde(default)] + pub authors: Vec, + #[serde(default)] + pub license: String, + // Include optional license file path and/or web link? +} + +#[derive(Clone, Deserialize)] +pub struct Contributor { + pub name: String, + /// Short note or description of the contributions + /// Optional, can be left empty/ommitted + #[serde(default)] + pub contributions: String, +} + +/// Credits manifest processed into format for display in the UI +#[derive(Clone, Deserialize)] +pub struct Credits { + pub music: Vec, + pub fonts: Vec, + pub other_art: Vec, + pub contributors: Vec, + // TODO: include credits for dependencies where the license requires attribution? +} + +impl assets::Asset for Credits { + type Loader = assets::RonLoader; + + const EXTENSION: &'static str = "ron"; +} diff --git a/voxygen/src/lib.rs b/voxygen/src/lib.rs index da3bde5232..e7ff518c3c 100644 --- a/voxygen/src/lib.rs +++ b/voxygen/src/lib.rs @@ -16,6 +16,7 @@ pub mod ui; pub mod audio; pub mod controller; +mod credits; mod ecs; pub mod error; pub mod game_input; diff --git a/voxygen/src/menu/main/ui/credits.rs b/voxygen/src/menu/main/ui/credits.rs new file mode 100644 index 0000000000..b68b0635de --- /dev/null +++ b/voxygen/src/menu/main/ui/credits.rs @@ -0,0 +1,195 @@ +use super::Message; +use crate::{ + credits::Credits, + ui::{ + fonts::IcedFonts as Fonts, + ice::{component::neat_button, style, Element}, + }, +}; +use i18n::Localization; +use iced::{button, scrollable, Column, Container, Length, Scrollable, Space}; + +/// Connecting screen for the main menu +pub struct Screen { + back_button: button::State, + scroll: scrollable::State, +} + +impl Screen { + pub fn new() -> Self { + Self { + back_button: Default::default(), + scroll: Default::default(), + } + } + + pub(super) fn view( + &mut self, + fonts: &Fonts, + i18n: &Localization, + credits: &Credits, + button_style: style::button::Style, + ) -> Element { + use core::fmt::Write; + // TODO: i18n and better formating + let format_art_credit = |credit: &crate::credits::Art| -> Result { + let mut text = String::new(); + text.push_str(&credit.name); + + let mut authors = credit.authors.iter(); + if let Some(author) = authors.next() { + write!(&mut text, " created by {}", author)?; + } + authors.try_for_each(|author| write!(&mut text, ", {}", author))?; + + if !credit.license.is_empty() { + write!(&mut text, " ({})", &credit.license)?; + } + + Ok::<_, core::fmt::Error>(text) + }; + let format_contributor_credit = + |credit: &crate::credits::Contributor| -> Result { + let mut text = String::new(); + text.push_str(&credit.name); + + if !credit.contributions.is_empty() { + write!(&mut text, ": {}", &credit.contributions)?; + } + + Ok(text) + }; + + let music_header_color = iced::Color::from_rgb8(0xfc, 0x71, 0x76); + let fonts_header_color = iced::Color::from_rgb8(0xf7, 0xd1, 0x81); + let other_art_header_color = iced::Color::from_rgb8(0xc5, 0xe9, 0x80); + let contributors_header_color = iced::Color::from_rgb8(0x4a, 0xa6, 0x7b); + + Container::new( + Container::new( + Column::with_children(vec![ + iced::Text::new(i18n.get("main.credits")) + .font(fonts.alkhemi.id) + .size(fonts.alkhemi.scale(35)) + .into(), + Space::new(Length::Fill, Length::Units(25)).into(), + Scrollable::new(&mut self.scroll) + .push(Column::with_children( + core::iter::once( + iced::Text::new(i18n.get("main.credits.music")) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(30)) + .color(music_header_color) + .into(), + ) + .chain(credits.music.iter().map(|credit| { + let text = format_art_credit(credit).expect("Formatting failed!!!"); + iced::Text::new(text) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(23)) + .into() + })) + .chain(core::iter::once( + Space::new(Length::Fill, Length::Units(15)).into(), + )) + .collect(), + )) + .push(Column::with_children( + core::iter::once( + iced::Text::new(i18n.get("main.credits.fonts")) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(30)) + .color(fonts_header_color) + .into(), + ) + .chain(credits.fonts.iter().map(|credit| { + let text = format_art_credit(credit).expect("Formatting failed!!!"); + iced::Text::new(text) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(23)) + .into() + })) + .chain(core::iter::once( + Space::new(Length::Fill, Length::Units(15)).into(), + )) + .collect(), + )) + .push(Column::with_children( + core::iter::once( + iced::Text::new(i18n.get("main.credits.other_art")) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(30)) + .color(other_art_header_color) + .into(), + ) + .chain(credits.other_art.iter().map(|credit| { + let text = format_art_credit(credit).expect("Formatting failed!!!"); + iced::Text::new(text) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(23)) + .into() + })) + .chain(core::iter::once( + Space::new(Length::Fill, Length::Units(15)).into(), + )) + .collect(), + )) + .push(Column::with_children( + core::iter::once( + iced::Text::new(i18n.get("main.credits.contributors")) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(30)) + .color(contributors_header_color) + .into(), + ) + .chain(credits.contributors.iter().map(|credit| { + let text = format_contributor_credit(credit) + .expect("Formatting failed!!!"); + iced::Text::new(text) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(23)) + .into() + })) + .chain(core::iter::once( + Space::new(Length::Fill, Length::Units(15)).into(), + )) + .collect(), + )) + .height(Length::FillPortion(1)) + .into(), + Container::new( + Container::new(neat_button( + &mut self.back_button, + i18n.get("common.back"), + 0.7, + button_style, + Some(Message::Back), + )) + .height(Length::Units(fonts.cyri.scale(50))), + ) + .center_x() + .height(Length::Shrink) + .width(Length::Fill) + .into(), + ]) + .spacing(5) + .padding(20) + .width(Length::Fill) + .height(Length::Fill), + ) + .style( + style::container::Style::color_with_double_cornerless_border( + (22, 19, 17, 255).into(), + (11, 11, 11, 255).into(), + (54, 46, 38, 255).into(), + ), + ), + ) + .center_x() + .center_y() + .padding(70) + .width(Length::Fill) + .height(Length::Fill) + .into() + } +} diff --git a/voxygen/src/menu/main/ui/login.rs b/voxygen/src/menu/main/ui/login.rs index 9234e713d6..0ac08c54c0 100644 --- a/voxygen/src/menu/main/ui/login.rs +++ b/voxygen/src/menu/main/ui/login.rs @@ -26,6 +26,7 @@ pub struct Screen { quit_button: button::State, settings_button: button::State, servers_button: button::State, + credits_button: button::State, language_select_button: button::State, error_okay_button: button::State, @@ -38,6 +39,7 @@ impl Screen { pub fn new() -> Self { Self { servers_button: Default::default(), + credits_button: Default::default(), settings_button: Default::default(), quit_button: Default::default(), language_select_button: Default::default(), @@ -85,6 +87,13 @@ impl Screen { button_style, Some(Message::OpenLanguageMenu), ), + neat_button( + &mut self.credits_button, + i18n.get("main.credits"), + FILL_FRAC_ONE, + button_style, + Some(Message::ShowCredits), + ), neat_button( &mut self.quit_button, i18n.get("common.quit"), diff --git a/voxygen/src/menu/main/ui/mod.rs b/voxygen/src/menu/main/ui/mod.rs index a013750891..ee23c541c1 100644 --- a/voxygen/src/menu/main/ui/mod.rs +++ b/voxygen/src/menu/main/ui/mod.rs @@ -1,10 +1,12 @@ mod connecting; // Note: Keeping in case we re-add the disclaimer //mod disclaimer; +mod credits; mod login; mod servers; use crate::{ + credits::Credits, render::UiDrawer, ui::{ self, @@ -101,6 +103,9 @@ enum Screen { /*Disclaimer { screen: disclaimer::Screen, },*/ + Credits { + screen: credits::Screen, + }, Login { screen: login::Screen, // Error to display in a box @@ -124,6 +129,7 @@ struct Controls { version: String, // Alpha disclaimer alpha: String, + credits: Credits, selected_server_index: Option, login_info: LoginInfo, @@ -141,6 +147,7 @@ enum Message { Quit, Back, ShowServers, + ShowCredits, #[cfg(feature = "singleplayer")] Singleplayer, Multiplayer, @@ -170,6 +177,8 @@ impl Controls { let version = common::util::DISPLAY_VERSION_LONG.clone(); let alpha = format!("Veloren {}", common::util::DISPLAY_VERSION.as_str()); + let credits = Credits::load_expect_cloned("common.credits"); + // Note: Keeping in case we re-add the disclaimer let screen = /* if settings.show_disclaimer { Screen::Disclaimer { @@ -205,6 +214,7 @@ impl Controls { i18n, version, alpha, + credits, selected_server_index, login_info, @@ -263,6 +273,9 @@ impl Controls { let content = match &mut self.screen { // Note: Keeping in case we re-add the disclaimer //Screen::Disclaimer { screen } => screen.view(&self.fonts, &self.i18n, button_style), + Screen::Credits { screen } => { + screen.view(&self.fonts, &self.i18n.read(), &self.credits, button_style) + }, Screen::Login { screen, error } => screen.view( &self.fonts, &self.imgs, @@ -334,6 +347,11 @@ impl Controls { }; } }, + Message::ShowCredits => { + self.screen = Screen::Credits { + screen: credits::Screen::new(), + }; + }, #[cfg(feature = "singleplayer")] Message::Singleplayer => { self.screen = Screen::Connecting { From 4e9007b45a685c28f079ec77aa71f0283d5deb91 Mon Sep 17 00:00:00 2001 From: Imbris Date: Thu, 30 Sep 2021 02:35:59 -0400 Subject: [PATCH 2/4] Add documentation to credits.ron and fill in fonts entries with actual data, add additional entries to Art credits for documenting information relevant to satifying attribution requirements for some licenses, add/rename license files for fonts, center credits text on the credits screen, added asset_path field to associate art credits with the actual asset files and wrote a unit test to ensure that these paths are valid. --- assets/common/credits.ron | 132 ++++++++++-- .../font/{OFL.txt => Metamorphous-OFL.txt} | 0 .../voxygen/font/OpenSans-Regular-LICENSE.txt | 202 ++++++++++++++++++ .../font/{license.txt => wizard-license.txt} | 0 assets/voxygen/i18n/en/main.ron | 1 + voxygen/src/credits.rs | 54 ++++- voxygen/src/menu/main/ui/credits.rs | 158 +++++++------- 7 files changed, 444 insertions(+), 103 deletions(-) rename assets/voxygen/font/{OFL.txt => Metamorphous-OFL.txt} (100%) create mode 100644 assets/voxygen/font/OpenSans-Regular-LICENSE.txt rename assets/voxygen/font/{license.txt => wizard-license.txt} (100%) diff --git a/assets/common/credits.ron b/assets/common/credits.ron index 0541b3a504..dea31981f7 100644 --- a/assets/common/credits.ron +++ b/assets/common/credits.ron @@ -1,23 +1,117 @@ ( + // See best attribution practices for creative commons licenses: + // https://wiki.creativecommons.org/wiki/Best_practices_for_attribution + + // TODO: remove placeholder entries when actual ones are added for a section + // + // TODO: split this into a file for each of common/voxygen/server assets (applications will + // need to ensure to properly combine them) + // + /// Entry format: + /// ``` + /// ( + /// name: "Name of art", + /// // Provide if the asset is from or derived from an external source that can be + /// // linked. + /// source_link: "https://fonts.com/fancyfont/", + /// // Can be omitted if no authors are listed for some reason. + /// // TODO: differentiate original authors and authors of derivative work / modifications? + /// // Maybe for now this can be noted in parentheses like: "AuthorOne (source), AuthorTwo (derivative)"? + /// authors: ["Art creator, Art co-creator"], + /// // Must point to file that actually exists + /// // TODO: would it make sense to allow having a list of files here? + /// asset_path: "relative/path/to/asset.ext", + /// // Can be omitted, but assumed to be GPL3 if not provided. + /// license: "cc-by-sa 3", + /// // Link to the license, can be omitted if the license can't be linked and/or a + /// // local copy is provided. + /// license_link: "https://creativecommons.org/licenses/by-sa/3.0/", + /// // Note any modifcations if the original work has been modified + /// modfications: "Added additional characters to the font.", + /// // Any additional attribution notes that may be desired and/or required by the + /// // respective license that can't be conveyed or would be awkward to convey with the + /// // fields above. + /// notes: "Some other information", + /// ) + /// ``` music: [( - name: "Desert jams", - authors: ["AuthorOne", "author two"], + name: "Placeholder jams", + authors: ["Placeholder author", "Placeholder author two"], + asset_path: "common/credits.ron", // placeholder don't use this for actual entries + )], + fonts: [( + name: "Alkhemikal", + source_link: "https://fontenddev.com/fonts/alkhemikal/", + authors: ["jeti"], + asset_path: "voxygen/font/Alkhemikal.ttf", + license: "CC BY 4.0", + license_link: "https://creativecommons.org/licenses/by/4.0/", + ), ( + name: "bdfUMplus outline", + authors: ["hikaen2"], + asset_path: "voxygen/font/bdfUMplus-outline.ttf", + // License text file included alongside font which should satisfy the requirements. + license: "MIT", + ), ( + name: "HaxrCorp 4089 Cyrillic AltGr", + source_link: "https://fontstruct.com/fontstructions/show/330387/haxrcorp_4089_cyrillic_altgr", + authors: ["sahwar"], + asset_path: "voxygen/font/haxrcorp_4089_cyrillic_altgr.ttf", + license: "CC BY-SA 3.0", + license_link: "https://creativecommons.org/licenses/by-sa/3.0/", + ), ( + name: "HaxrCorp 4089 Cyrillic AltGr Extended", + source_link: "https://fontstruct.com/fontstructions/show/330387/haxrcorp_4089_cyrillic_altgr", + authors: ["sahwar (source)"], + asset_path: "voxygen/font/haxrcorp_4089_cyrillic_altgr_extended.ttf", + license: "CC BY-SA 3.0", + license_link: "https://creativecommons.org/licenses/by-sa/3.0/", + modifications: "Added additional characters.", + ), ( + name: "Metamorphous", + authors: ["Sorkin Type Co"], + asset_path: "voxygen/font/Metamorphous-Regular.ttf", + // License appears to be satisfied by inclusion of its text file. + license: "OFL", + license_link: "https://scripts.sil.org/OFL", + ), ( + name: "Open Sans", + authors: [""], + asset_path: "voxygen/font/OpenSans-Regular.ttf", + // License appears to be satisfied by inclusion of its text file. + license: "Apache 2.0", + license_link: "http://www.apache.org/licenses/LICENSE-2.0", + ), ( + name: "WenQuanYi Zen Hei", + source_link: "http://wenq.org/wqy2/index.cgi?ZenHei%28en%29", + authors: ["Qianqian Fang", "WenQuanYi project"], + asset_path: "voxygen/font/WenQuanYiZenHei.ttf", + license: "GPL2", + license_link: "http://wenq.org/wqy2/index.cgi?GPL", + ), ( + name: "Wizard", + source_link: "https://fontstruct.com/fontstructions/show/1506403/wizard-5", + authors: ["Omegaville"], + asset_path: "voxygen/font/wizard.ttf", + license: "CC BY-SA 3.0", + license_link: "https://creativecommons.org/licenses/by-sa/3.0/", + )], + other_art: [( + name: "Placeholder voxels", + authors: ["Placeholder"], + asset_path: "common/credits.ron", // placeholder don't use this for actual entries + )], + /// Entry format: + /// ``` + /// ( + /// name: "Contributor name", + /// contributions: "Note about what contributor contributed", // optional, field can be omitted + /// ) + /// ``` + contributors: [( + name: "Placeholder", + contributions: "An example note", + ), ( + name: "Example Two", )], - fonts: [( - name: "Wizard", - license: "cc-by-sa 3", - )], - other_art: [( - name: "Voxel shrooms", - authors: ["AuthorOne", "author two"], - )], - contributors: [ - ( - name: "Example", - contributions: "An example note", - ), - ( - name: "Example Two", - ), - ], ) diff --git a/assets/voxygen/font/OFL.txt b/assets/voxygen/font/Metamorphous-OFL.txt similarity index 100% rename from assets/voxygen/font/OFL.txt rename to assets/voxygen/font/Metamorphous-OFL.txt diff --git a/assets/voxygen/font/OpenSans-Regular-LICENSE.txt b/assets/voxygen/font/OpenSans-Regular-LICENSE.txt new file mode 100644 index 0000000000..75b52484ea --- /dev/null +++ b/assets/voxygen/font/OpenSans-Regular-LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/assets/voxygen/font/license.txt b/assets/voxygen/font/wizard-license.txt similarity index 100% rename from assets/voxygen/font/license.txt rename to assets/voxygen/font/wizard-license.txt diff --git a/assets/voxygen/i18n/en/main.ron b/assets/voxygen/i18n/en/main.ron index 650721de8d..fe0822df17 100644 --- a/assets/voxygen/i18n/en/main.ron +++ b/assets/voxygen/i18n/en/main.ron @@ -64,6 +64,7 @@ https://veloren.net/account/."#, // Credits screen "main.credits": "Credits", + "main.credits.created_by": "created by", "main.credits.music": "Music", "main.credits.fonts": "Fonts", "main.credits.other_art": "Other Art", diff --git a/voxygen/src/credits.rs b/voxygen/src/credits.rs index 45bcdc215d..975cd30b9d 100644 --- a/voxygen/src/credits.rs +++ b/voxygen/src/credits.rs @@ -1,20 +1,44 @@ use common::assets; use serde::Deserialize; +use std::path::PathBuf; // NOTE: we are free to split the manifest asset format and the format processed // for display into separate structs but they happen to be identical for now -// TODO: add serde attribs to certain fields +// See best practices for attribution: https://wiki.creativecommons.org/wiki/Best_practices_for_attribution #[derive(Clone, Deserialize)] pub struct Art { + /// Name of the art. pub name: String, - // Include asset path as a field? + /// Link if the asset is from or derived from an external source that can be + /// linked. + #[serde(default)] + pub source_link: String, + /// List of authors for the credited art, field can be omitted if there are + /// no authors to list. #[serde(default)] pub authors: Vec, + /// Relative path to the asset from the top level asset folder. + /// Used so we can keep track of the actual files, but not currently used in + /// the credits screen to display anything. + pub asset_path: PathBuf, + /// License that the art is under, can be omitted, if not present assumed to + /// be GPL3. #[serde(default)] pub license: String, - // Include optional license file path and/or web link? + /// Link to the license if one is available. + #[serde(default)] + pub license_link: String, + /// Notes on any modifications that were made if the original work was + /// modified by us. + #[serde(default)] + pub modifications: String, + /// Any additional attribution notes that may be desired and/or required by + /// the respactive license that can't be conveyed or would be awkward to + /// convey with the other provided fields. + #[serde(default)] + pub notes: String, } #[derive(Clone, Deserialize)] @@ -41,3 +65,27 @@ impl assets::Asset for Credits { const EXTENSION: &'static str = "ron"; } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn all_art_asset_paths_exists() { + use assets::AssetExt; + let credits = Credits::load_expect_cloned("common.credits"); + + credits + .music + .into_iter() + .chain(credits.fonts) + .chain(credits.other_art) + .for_each(|art| { + assert!( + assets::ASSETS_PATH.join(&art.asset_path).exists(), + "assets/{} does not exist!", + art.asset_path.display(), + ); + }); + } +} diff --git a/voxygen/src/menu/main/ui/credits.rs b/voxygen/src/menu/main/ui/credits.rs index b68b0635de..2770d7892e 100644 --- a/voxygen/src/menu/main/ui/credits.rs +++ b/voxygen/src/menu/main/ui/credits.rs @@ -7,7 +7,7 @@ use crate::{ }, }; use i18n::Localization; -use iced::{button, scrollable, Column, Container, Length, Scrollable, Space}; +use iced::{button, scrollable, Column, Container, HorizontalAlignment, Length, Scrollable, Space}; /// Connecting screen for the main menu pub struct Screen { @@ -31,14 +31,18 @@ impl Screen { button_style: style::button::Style, ) -> Element { use core::fmt::Write; - // TODO: i18n and better formating let format_art_credit = |credit: &crate::credits::Art| -> Result { let mut text = String::new(); - text.push_str(&credit.name); + write!(&mut text, "\"{}\"", &credit.name)?; let mut authors = credit.authors.iter(); if let Some(author) = authors.next() { - write!(&mut text, " created by {}", author)?; + write!( + &mut text, + " {} {}", + i18n.get("main.credits.created_by"), + author + )?; } authors.try_for_each(|author| write!(&mut text, ", {}", author))?; @@ -65,97 +69,89 @@ impl Screen { let other_art_header_color = iced::Color::from_rgb8(0xc5, 0xe9, 0x80); let contributors_header_color = iced::Color::from_rgb8(0x4a, 0xa6, 0x7b); + fn credit_section<'a, T>( + header_i18n_key: &str, + header_color: iced::Color, + credit_iter: impl Iterator, + format_credit: impl Fn(T) -> Result, + fonts: &Fonts, + i18n: &Localization, + ) -> Element<'a, Message> { + Column::with_children( + core::iter::once( + iced::Text::new(i18n.get(header_i18n_key)) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(30)) + .color(header_color) + .width(Length::Fill) + .horizontal_alignment(HorizontalAlignment::Center) + .into(), + ) + .chain(credit_iter.map(|credit| { + let text = format_credit(credit).expect("Formatting failed!!!"); + iced::Text::new(text) + .font(fonts.cyri.id) + .size(fonts.cyri.scale(23)) + .width(Length::Fill) + .horizontal_alignment(HorizontalAlignment::Center) + .into() + })) + .chain(core::iter::once( + Space::new(Length::Fill, Length::Units(15)).into(), + )) + .collect(), + ) + .width(Length::Fill) + .into() + } + + let art_section = |header_i18n_key, header_color, art: &[_]| { + credit_section( + header_i18n_key, + header_color, + art.iter(), + format_art_credit, + fonts, + i18n, + ) + }; + Container::new( Container::new( Column::with_children(vec![ iced::Text::new(i18n.get("main.credits")) .font(fonts.alkhemi.id) .size(fonts.alkhemi.scale(35)) + .width(Length::Fill) + .horizontal_alignment(HorizontalAlignment::Center) .into(), Space::new(Length::Fill, Length::Units(25)).into(), Scrollable::new(&mut self.scroll) - .push(Column::with_children( - core::iter::once( - iced::Text::new(i18n.get("main.credits.music")) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(30)) - .color(music_header_color) - .into(), - ) - .chain(credits.music.iter().map(|credit| { - let text = format_art_credit(credit).expect("Formatting failed!!!"); - iced::Text::new(text) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(23)) - .into() - })) - .chain(core::iter::once( - Space::new(Length::Fill, Length::Units(15)).into(), - )) - .collect(), + .push(art_section( + "main.credits.music", + music_header_color, + &credits.music, )) - .push(Column::with_children( - core::iter::once( - iced::Text::new(i18n.get("main.credits.fonts")) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(30)) - .color(fonts_header_color) - .into(), - ) - .chain(credits.fonts.iter().map(|credit| { - let text = format_art_credit(credit).expect("Formatting failed!!!"); - iced::Text::new(text) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(23)) - .into() - })) - .chain(core::iter::once( - Space::new(Length::Fill, Length::Units(15)).into(), - )) - .collect(), + .push(art_section( + "main.credits.fonts", + fonts_header_color, + &credits.fonts, )) - .push(Column::with_children( - core::iter::once( - iced::Text::new(i18n.get("main.credits.other_art")) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(30)) - .color(other_art_header_color) - .into(), - ) - .chain(credits.other_art.iter().map(|credit| { - let text = format_art_credit(credit).expect("Formatting failed!!!"); - iced::Text::new(text) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(23)) - .into() - })) - .chain(core::iter::once( - Space::new(Length::Fill, Length::Units(15)).into(), - )) - .collect(), + .push(art_section( + "main.credits.other_art", + other_art_header_color, + &credits.other_art, )) - .push(Column::with_children( - core::iter::once( - iced::Text::new(i18n.get("main.credits.contributors")) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(30)) - .color(contributors_header_color) - .into(), - ) - .chain(credits.contributors.iter().map(|credit| { - let text = format_contributor_credit(credit) - .expect("Formatting failed!!!"); - iced::Text::new(text) - .font(fonts.cyri.id) - .size(fonts.cyri.scale(23)) - .into() - })) - .chain(core::iter::once( - Space::new(Length::Fill, Length::Units(15)).into(), - )) - .collect(), + .push(credit_section( + "main.credits.contributors", + contributors_header_color, + credits.contributors.iter(), + format_contributor_credit, + fonts, + i18n, )) .height(Length::FillPortion(1)) + .width(Length::Fill) .into(), Container::new( Container::new(neat_button( From 7fca34668ac74e6ae426b163d3552d7dfaa36502 Mon Sep 17 00:00:00 2001 From: Imbris Date: Thu, 30 Sep 2021 02:44:16 -0400 Subject: [PATCH 3/4] Make gitlab hightlight syntax for ron files (using rust syntax highlighting). Update changelog for credits addition. Fix clippy large variant issue. --- .gitattributes | 2 ++ CHANGELOG.md | 1 + voxygen/src/menu/main/ui/mod.rs | 10 +++++----- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.gitattributes b/.gitattributes index 14cfdace2d..1c2d6e5b09 100644 --- a/.gitattributes +++ b/.gitattributes @@ -8,4 +8,6 @@ *.ico filter=lfs diff=lfs merge=lfs -text *.tar filter=lfs diff=lfs merge=lfs -text assets/world/map/*.bin filter=lfs diff=lfs merge=lfs -text + +*.ron gitlab-language=rust * !text !filter !merge !diff diff --git a/CHANGELOG.md b/CHANGELOG.md index 3fb375711c..9fdaf58bee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added a setting to always show health and energy bars - Added a crafting station icon to the crafting menu sidebar for items that could be crafted at a crafting station - Added a setting to disable the hotkey hints +- Added a credits screen in the main menu which shows attributions for assets ### Changed diff --git a/voxygen/src/menu/main/ui/mod.rs b/voxygen/src/menu/main/ui/mod.rs index ee23c541c1..fee8c40660 100644 --- a/voxygen/src/menu/main/ui/mod.rs +++ b/voxygen/src/menu/main/ui/mod.rs @@ -107,7 +107,7 @@ enum Screen { screen: credits::Screen, }, Login { - screen: login::Screen, + screen: Box, // boxed to avoid large variant // Error to display in a box error: Option, }, @@ -186,7 +186,7 @@ impl Controls { } } else { */ Screen::Login { - screen: login::Screen::new(), + screen: Box::new(login::Screen::new()), error: None, }; //}; @@ -334,7 +334,7 @@ impl Controls { Message::Quit => events.push(Event::Quit), Message::Back => { self.screen = Screen::Login { - screen: login::Screen::new(), + screen: Box::new(login::Screen::new()), error: None, }; }, @@ -431,7 +431,7 @@ impl Controls { fn exit_connect_screen(&mut self) { if matches!(&self.screen, Screen::Connecting { .. }) { self.screen = Screen::Login { - screen: login::Screen::new(), + screen: Box::new(login::Screen::new()), error: None, } } @@ -457,7 +457,7 @@ impl Controls { fn connection_error(&mut self, error: String) { if matches!(&self.screen, Screen::Connecting { .. }) { self.screen = Screen::Login { - screen: login::Screen::new(), + screen: Box::new(login::Screen::new()), error: Some(error), } } From d77a0779ca24bf5130370b7366afc3e66fa95584 Mon Sep 17 00:00:00 2001 From: Imbris Date: Fri, 1 Oct 2021 20:41:42 -0400 Subject: [PATCH 4/4] Add core devs to the contributors list in credits.ron and remove placeholder entries in empty art sections (in favor of displaying nothing) --- assets/common/credits.ron | 43 ++++++++++++++++++----------- voxygen/src/menu/main/ui/credits.rs | 2 +- 2 files changed, 28 insertions(+), 17 deletions(-) diff --git a/assets/common/credits.ron b/assets/common/credits.ron index dea31981f7..c7c8aa801c 100644 --- a/assets/common/credits.ron +++ b/assets/common/credits.ron @@ -2,9 +2,7 @@ // See best attribution practices for creative commons licenses: // https://wiki.creativecommons.org/wiki/Best_practices_for_attribution - // TODO: remove placeholder entries when actual ones are added for a section - // - // TODO: split this into a file for each of common/voxygen/server assets (applications will + // TODO: consider splitting this into a file for each of common/voxygen/server assets (applications will // need to ensure to properly combine them) // /// Entry format: @@ -34,11 +32,7 @@ /// notes: "Some other information", /// ) /// ``` - music: [( - name: "Placeholder jams", - authors: ["Placeholder author", "Placeholder author two"], - asset_path: "common/credits.ron", // placeholder don't use this for actual entries - )], + music: [], fonts: [( name: "Alkhemikal", source_link: "https://fontenddev.com/fonts/alkhemikal/", @@ -96,11 +90,7 @@ license: "CC BY-SA 3.0", license_link: "https://creativecommons.org/licenses/by-sa/3.0/", )], - other_art: [( - name: "Placeholder voxels", - authors: ["Placeholder"], - asset_path: "common/credits.ron", // placeholder don't use this for actual entries - )], + other_art: [], /// Entry format: /// ``` /// ( @@ -109,9 +99,30 @@ /// ) /// ``` contributors: [( - name: "Placeholder", - contributions: "An example note", + name: "zesterer", ), ( - name: "Example Two", + name: "XVar", + ), ( + name: "xMAC94", + ), ( + name: "Timo", + ), ( + name: "Songtronix", + ), ( + name: "Snowram", + ), ( + name: "Slipped", + ), ( + name: "Sharp", + ), ( + name: "Sam", + ), ( + name: "Pfau", + ), ( + name: "imbris", + ), ( + name: "Christof", + ), ( + name: "AngelOnFira", )], ) diff --git a/voxygen/src/menu/main/ui/credits.rs b/voxygen/src/menu/main/ui/credits.rs index 2770d7892e..f98009a896 100644 --- a/voxygen/src/menu/main/ui/credits.rs +++ b/voxygen/src/menu/main/ui/credits.rs @@ -58,7 +58,7 @@ impl Screen { text.push_str(&credit.name); if !credit.contributions.is_empty() { - write!(&mut text, ": {}", &credit.contributions)?; + write!(&mut text, "- {}", &credit.contributions)?; } Ok(text)